Unigine::Synker::SlaveInterface Class

This class represents the slave interface of the Syncker.

SlaveInterface Class

Members

---

void setUdpRecvSize(int size)

Sets the maximum size of a UDP packet to be received.

Arguments

• int size - UDP packet size, in bytes. The default value is 1432.

int getUdpRecvSize()

Sets the maximum size of a UDP packet to be received.

Return value

UDP packet size, in bytes. The default value is 1432.

void setSkipWorldMessages(int skip)

Sets a value indicating if world messages (TCP and UDP) should be skipped.

Arguments

• int skip - 1 to skip world messages (TCP and UDP); 0 - to receive them.

void setSkipUserMessages(int skip)

Sets a value indicating if user messages (TCP and UDP) should be skipped.

Arguments

• int skip - 1 to skip user messages (TCP and UDP); 0 - to receive them.

int isWorldMessagesSkipped()

Returns a value indicating if world messages (TCP and UDP) are skipped.

Return value

1 if world messages (TCP and UDP) are skipped; otherwise, 0.

int isUserMessagesSkipped()

Returns a value indicating if user messages (TCP and UDP) are skipped.

Return value

1 if user messages (TCP and UDP) are skipped; otherwise, 0.

int isPacketsReceived()

Returns a value indicating if packets where received after the last update().

Return value

1 if packets were received after the last update(); otherwise, 0.

int isPacketsLost()

Returns a value indicating if there are missing packets after the last update().

Return value

1 if there are missing packets after the last update(); otherwise, 0.

double getMasterTime()

Returns the current master time (with latency corrections).

Return value

Current master time, in seconds.

int hasCAVE()

Returns the value indicating if there are viewer's head position synchronization packets received after the last update().

Return value

1 if there are viewer's head position synchronization packets received after the last update(); otherwise, 0.

int hasEnd()

Returns the value indicating if there is a frame_end synchronization packet received after the last update().

Return value

1 if there is a frame_end synchronization packet received after the last update(); otherwise, 0.

int hasFrame()

Returns the value indicating if there is a frame_start synchronization packet received after the last update().

Return value

1 if there is a frame_start synchronization packet received after the last update(); otherwise, 0.

int hasPlayer()

Returns the value indicating if there are player synchronization packets received after the last update().

Return value

1 if there are player synchronization packets received after the last update(); otherwise, 0.

int hasRender()

Returns the value indicating if there are render synchronization packets received after the last update().

Return value

1 if there are render synchronization packets received after the last update(); otherwise, 0.

int hasUser()

Returns the value indicating if there are user's synchronization packets received after the last update().

Return value

1 if there are user's synchronization packets received after the last update(); otherwise, 0.

void sendTCPUser(const BlobPtr & message)

Sends a user message contained in the specified buffer to the master via the TCP protocol.

Arguments

• const BlobPtr & message - Buffer, containing a user message.

void setTCPUserReceiveCallback(Unigine::CallbackBase * func)

Sets a callback function to be fired when a TCP user message is received.

Arguments

• Unigine::CallbackBase * func - Callback pointer.

void setUDPUserReceiveCallback(Unigine::CallbackBase * func)

Sets a callback function to be fired when a UDP user message is received.

Arguments

• Unigine::CallbackBase * func - Callback pointer.