Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
languagecpp
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
NameCommsConnected
Linkedtrue
TypeConnectedFunc
StyleMember

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
NameCommsAccept
Linkedtrue
TypeAcceptFunc
StyleMember

Called to ask your component if they want it is willing to accept a connection from another component.

Vardef
NameCommsClose
Linkedtrue
TypeDisconnectFunc
StyleMember

Called when a connection to your component is closed. This typically occurs when WinGate Management disconnects.

Vardef
NameCommsRecv
Linkedtrue
TypeSendFunc
StyleMember

Called by the framework when there is data to receive from on a connected componentconnection.

Vardef
NameCommsRecvBroadcast
Linkedtrue
TypeRecvBroadcastFunc
StyleMember
Optionaltrue

TBDCalled when there is broadcast data to receive

Vardef
NameCommsMulticastNotify
Linkedtrue
TypeMulticastNotifyFunc
StyleMember
Optionaltrue

TBD

Vardef
NameCommsMulticastReceive
Linkedtrue
TypeMulticastReceiveFunc
StyleMember
Optionaltrue

TBD