Unigine::Plugins::Syncker::Manager Class

Manager Class

Members

---

bool getArgIsMaster ( ) #

Returns a value indicating if the command line argument "-sync_master" equals to 1.

Return value

true if the command line argument "-sync_master" equals to 1; otherwise, false.

const char * getArgMasterBroadcast ( ) #

Returns the master's broadcast address specified by the command line argument "-sync_broadcast_address".

Return value

Master's broadcast address. The default value is 127.255.255.255

const char * getArgSlaveName ( ) #

Returns the slave name set by the command line argument "-sync_slave_name". The default name is slave.

Return value

Slave name.

int getArgUdpPort ( ) #

Returns the UDP port value set by the command line argument "-sync_udp_port".

Return value

UDP port number. The default value is 8890.

int getArgTcpPort ( ) #

Returns the TCP port value set by the command line argument "-sync_tcp_port".

Return value

TCP port number. The default value is 8891.

int getArgTcpPingPort ( ) #

Returns the TCP ping port value set by the command line argument "-sync_tcp_ping_port".

Return value

TCP ping port number. The default value is 8892.

Master * initMaster ( const char * broadcast_address, int udp_port = 8890, int tcp_port = 8891, int tcp_ping_port = 8892, int compress_quality = COMPRESS_QUALITY_HIGH ) #

Initializes the Syncker in the master application using the given parameters.

Arguments

• const char * broadcast_address - Broadcast address.
• int udp_port - UDP port. The default value is 8890.
• int tcp_port - TCP port. The default value is 8891.
• int tcp_ping_port - TCP ping port. The default value is 8892.
• int compress_quality - Compression quality. One of the COMPRESS_QUALITY_* values. The default value is COMPRESS_QUALITY_HIGH.

Return value

Pointer to the master interface.

int isMasterInitialized ( ) #

Returns a value indicating if the master was initialized.

Return value

1 if the master was initialized; otherwise, 0.

Master * getMaster ( ) #

Returns the master interface.

Return value

Pointer to the master interface.

Slave * initSlave ( const char * name, int udp_port = 8890, int tcp_port = 8891, int tcp_ping_port = 8892, int compress_quality = COMPRESS_QUALITY_HIGH ) #

Initializes the Syncker in the slave application using the given parameters.

Arguments

• const char * name - Slave name.
• int udp_port - UDP port. The default value is 8890.
• int tcp_port - TCP port. The default value is 8891.
• int tcp_ping_port - TCP ping port. The default value is 8892.
• int compress_quality - Compression quality. One of the COMPRESS_QUALITY_* values. The default value is COMPRESS_QUALITY_HIGH.

Return value

Pointer to the slave interface.

int isSlaveInitialized ( ) #

Returns a value indicating if the slave was initialized.

Return value

1 if the slave was initialized; otherwise, 0.

Slave * getSlave ( ) #

Returns the slave interface.

Return value

Pointer to the slave interface.

int isSynckerInitialized ( ) #

Returns a value indicating if the Syncker (master or slave) was initialized.

Return value

1 if the Syncker (master or slave) was initialized; otherwise, 0.

Syncker * getSyncker ( ) #

Returns the syncker interface.

Return value

Pointer to the syncker interface.

int setDebugWindow ( int enabled ) #

Sets a value indicating if the Syncker's debug window is open.

Arguments

• int enabled - Enable flag. Use 1 to show the debug window, or 0 - to hide it.

Return value

1 if the Syncker's debug window is open; otherwise, 0.

int isDebugWindow ( ) #

Returns a value indicating if the Syncker's debug window is enabled.

Return value

1 if the Syncker's debug window is enabled; otherwise, 0.

void destroySyncker ( ) #

Performs shutdown and destroys the Syncker.