Unigine.Plugins.Syncker.Manager Class

Manager Class

Properties

bool IsDebugWindow#

Syncker Syncker#

bool IsSynckerInitialized#

Slave Slave#

bool IsSlaveInitialized#

Master Master#

bool IsMasterInitialized#

bool ArgAllowExtraSlaves#

int ArgUdpSlavePort#

int ArgUdpPort#

string ArgMasterAddress#

string ArgMulticastAddress#

string ArgBroadcastAddress#

int ArgPeersCount#

bool ArgIsAsyncMode#

Syncker.ADDRESSING_METHOD ArgAddressingMethod#

bool ArgIsMaster#

Members

---

Syncker.ADDRESSING_METHOD GetArgAddressingMethod ( ) #

Returns the addressing mode value set by the command line argument "-sync_method".

Return value

Current addressing mode: one of the ADDRESSING_METHOD enum values.

bool GetArgIsAsyncMode ( ) #

Returns a value indicating if asynchronous mode is enabled (the command line argument "-sync_async" equals to 1).

Return value

true if asynchronous mode is enabled; otherwise, false.

int GetArgPeersCount ( ) #

Returns the number of peers set by the command line argument "-sync_count".

Return value

Number of peers. The default value is 1. The number of peers includes all Slaves in the network + the Master.

string GetArgBroadcastAddress ( ) #

Returns the broadcast address of the Master set by the command line argument "-sync_broadcast_address".

Return value

Broadcast address of the Master.

string GetArgMulticastAddress ( ) #

Returns the multicast address of the Master set by the command line argument "-sync_multicast_address".

Return value

Multicast address of the Master. The default value is 239.0.0.1

string GetArgMasterAddress ( ) #

Returns the IP address of the Master set by the command line argument "-sync_master_address".

Return value

IP address of the Master.

int GetArgUdpSlavePort ( ) #

Returns the UDP port used by the Slave set by the command line argument "-sync_slave_port".

Return value

UDP port used by the Slave. The default value is 0 (any unused port available).

bool GetArgAllowExtraSlaves ( ) #

Returns the value indicating if additional Slaves can be connected after starting the session set by the command line argument "-sync_allow_extra_slaves".

Return value

true if additional Slaves can be connected after starting the session; otherwise, false.

Master InitMaster ( ) #

Initializes the Syncker as the Master application using values specified via the command-line arguments.

Return value

Master InitMasterBroadcast ( bool async_mode, int peers_count, string broadcast_address, ushort udp_port ) #

Initializes the Syncker as the Master application with the broadcast mode enabled.

Arguments

• bool async_mode - Async mode flag. Set true to use asynchronous mode; false - to use synchronous mode.Similar to specifying the -sync_async command-line argument.
  Notice

  Slaves must use the same synchronization mode as the Master.
• int peers_count - Total number of Syncker hosts in the network (including the Master itself). Similar to specifying the -sync_count command-line argument.
• string broadcast_address - Broadcast address to be used. Similar to specifying the -sync_broadcast_address command-line argument.
• ushort udp_port - Broadcast address to be used. Similar to specifying the -sync_broadcast_address command-line argument.

Return value

Master InitMasterMulticast ( bool async_mode, int peers_count, string multicast_address, ushort udp_port ) #

Initializes the Syncker as the Master application with the multicast mode enabled.

Arguments

• bool async_mode - Async mode flag. Set true to use asynchronous mode; false - to use synchronous mode.Similar to specifying the -sync_async command-line argument.
  Notice

  Slaves must use the same synchronization mode as the Master.
• int peers_count - Total number of Syncker hosts in the network (including the Master itself). Similar to specifying the -sync_count command-line argument.
• string multicast_address - Multicast address to be used. Similar to specifying the -sync_multicast_address command-line argument.
• ushort udp_port - UDP port to be used. Similar to specifying the -sync_port command-line argument.

Return value

Master InitMasterUnicast ( bool async_mode, int peers_count, ushort udp_port ) #

Initializes the Syncker as the Master application with the broadcast mode enabled.

Arguments

• bool async_mode - Async mode flag. Set true to use asynchronous mode; false - to use synchronous mode.Similar to specifying the -sync_async command-line argument.
  Notice

  Slaves must use the same synchronization mode as the Master.
• int peers_count - Total number of Syncker hosts in the network (including the Master itself). Similar to specifying the -sync_count command-line argument.
• ushort udp_port - UDP port to be used. Similar to specifying the -sync_port command-line argument.

Return value

Slave InitSlave ( ) #

Initializes the Syncker as the Slave application using values specified via the command-line arguments.

Return value

void DestroySyncker ( ) #

Performs shutdown and destroys the Syncker.

Slave InitSlaveBroadcast ( bool async_mode, ushort udp_port ) #

Initializes the Syncker as the Slave application with the broadcast mode enabled. Master's IP address will be detected automatically.

Arguments

• bool async_mode - Async mode flag. Set true to use asynchronous mode; false - to use synchronous mode.Similar to specifying the -sync_async command-line argument.
  Notice

  Slaves must use the same synchronization mode as the Master.
• ushort udp_port - UDP port to be used. Similar to specifying the -sync_port command-line argument.

Return value

Slave interface instance.

Slave InitSlaveBroadcast ( bool async_mode, string master_address, ushort udp_port ) #

Initializes the Syncker as the Slave application with the specified parameters and the broadcast mode enabled. Master's IP address is specified explicitly.

Arguments

• bool async_mode - Async mode flag. Set true to use asynchronous mode; false - to use synchronous mode.Similar to specifying the -sync_async command-line argument.
  Notice

  Slaves must use the same synchronization mode as the Master.
• string master_address - Master IP address to be used. Similar to specifying the -sync_master_address command-line argument.
• ushort udp_port - UDP port to be used. Similar to specifying the -sync_port command-line argument.

Return value

Slave interface instance.

Slave InitSlaveMulticast ( bool async_mode, string multicast_address, ushort udp_port ) #

Initializes the Syncker as the Slave application with the specified parameters and the multicast mode enabled. Master's IP address will be detected automatically.

Arguments

• bool async_mode - Async mode flag. Set true to use asynchronous mode; false - to use synchronous mode.Similar to specifying the -sync_async command-line argument.
  Notice

  Slaves must use the same synchronization mode as the Master.
• string multicast_address - Multicast address to be used. Similar to specifying the -sync_multicast_address command-line argument.
• ushort udp_port - UDP port to be used. Similar to specifying the -sync_port command-line argument.

Return value

Slave interface instance.

Slave InitSlaveMulticast ( bool async_mode, string master_address, string multicast_address, ushort udp_port ) #

Initializes the Syncker as the Slave application with the specified parameters and the multicast mode enabled. Master's IP address is specified explicitly.

Arguments

• bool async_mode - Async mode flag. Set true to use asynchronous mode; false - to use synchronous mode.Similar to specifying the -sync_async command-line argument.
  Notice

  Slaves must use the same synchronization mode as the Master.
• string master_address - Master IP address to be used. Similar to specifying the -sync_master_address command-line argument.
• string multicast_address - Multicast address to be used. Similar to specifying the -sync_multicast_address command-line argument.
• ushort udp_port - UDP port to be used. Similar to specifying the -sync_port command-line argument.

Return value

Slave interface instance.

Slave InitSlaveUnicast ( bool async_mode, ushort master_udp_port, ushort slave_udp_port = 0 ) #

Initializes the Syncker as the Slave application with the specified parameters and the unicast mode enabled. Master's IP address will be detected automatically.

Arguments

• bool async_mode - Async mode flag. Set true to use asynchronous mode; false - to use synchronous mode.Similar to specifying the -sync_async command-line argument.
  Notice

  Slaves must use the same synchronization mode as the Master.
• ushort master_udp_port - UDP port to be used by the Master.
• ushort slave_udp_port - UDP port to be used by the Slave. Similar to specifying the -sync_slave_port command-line argument.

Return value

Slave interface instance.

Slave InitSlaveUnicast ( bool async_mode, string master_address, ushort master_udp_port, ushort slave_udp_port = 0 ) #

Initializes the Syncker as the Slave application with the specified parameters and the unicast mode enabled. Master's IP address is specified explicitly.

Arguments

• bool async_mode - Async mode flag. Set true to use asynchronous mode; false - to use synchronous mode.Similar to specifying the -sync_async command-line argument.
  Notice

  Slaves must use the same synchronization mode as the Master.
• string master_address - Master IP address to be used. Similar to specifying the -sync_master_address command-line argument.
• ushort master_udp_port - UDP port to be used by the Master.
• ushort slave_udp_port - UDP port to be used by the Slave. Similar to specifying the -sync_slave_port command-line argument.

Return value

Slave interface instance.

Syncker InitSyncker ( ) #

Initializes the Syncker as Master or Slave application depending on the values specified via the command-line arguments.

Return value

Syncker interface instance. It is the base class for Master and Slave.