The ComponentCommunicationsInterface objects define communication interfaces object defines a communication interface that components use to communicate with each other. To publish your ability to support communication between components, call RegisterInterface passing an initialised ComponentCommunicationsInterface object.
Code Block |
---|
|
WG_COMPONENT_INTERFACE(ComponentCommunicationsInterface)
ConnectedFunc CommsConnected;
AcceptFunc CommsAccept;
DisconnectFunc CommsClose;
SendFunc CommsRecv;
RecvBroadcastFunc CommsRecvBroadcast;
MulticastNofifyFunc CommsMulticastNotify;
MulticastReceiveFunc CommsMulticastReceive;
}; |
All these functions are called by the framework.
Vardef |
---|
Name | CommsConnected |
---|
Linked | true |
---|
Type | ConnectedFunc |
---|
Style | Member |
---|
|
Function called Called when a successful connection between UI and Engine components is establishedconnection request made by your component has completed successfully or been rejected. |
Vardef |
---|
Name | CommsAccept |
---|
Linked | true |
---|
Type | AcceptFunc |
---|
Style | Member |
---|
|
Called to ask your component if they want it is willing to accept a connection from another component. |
Vardef |
---|
Name | CommsClose |
---|
Linked | true |
---|
Type | DisconnectFunc |
---|
Style | Member |
---|
|
Called when a connection to your component is closed. This typically occurs when WinGate Management disconnects. |
Vardef |
---|
Name | CommsRecv |
---|
Linked | true |
---|
Type | SendFunc |
---|
Style | Member |
---|
|
Called by the framework when there is data to receive from on a connected componentconnection. |
Vardef |
---|
Name | CommsRecvBroadcast |
---|
Linked | true |
---|
Type | RecvBroadcastFunc |
---|
Style | Member |
---|
Optional | true |
---|
|
TBDCalled when there is broadcast data to receive |
Vardef |
---|
Name | CommsMulticastNotify |
---|
Linked | true |
---|
Type | MulticastNotifyFunc |
---|
Style | Member |
---|
Optional | true |
---|
|
TBD |
Vardef |
---|
Name | CommsMulticastReceive |
---|
Linked | true |
---|
Type | MulticastReceiveFunc |
---|
Style | Member |
---|
Optional | true |
---|
|
TBD |