Unigine.Plugins.Syncker.Manager Class
Notice
Syncker plugin must be loaded.
This class represents Syncker manager interface used to initialize and destroy Syncker in master and slave applications.
Manager Class
Properties
bool DebugWindow#
The A value indicating if the syncker's debug window is enabled.
Syncker Syncker#
The syncker interface.
bool IsSynckerInitialized#
The A value indicating if the syncker (master or slave) was initialized.
Slave Slave#
The Slave interface.
bool IsSlaveInitialized#
The A value indicating if the Slave was initialized.
Master Master#
The Master interface.
bool IsMasterInitialized#
The A value indicating if the Master was initialized.
bool ArgAllowExtraSlaves#
The true if additional Slaves can be connected after starting the session; otherwise, false.
int ArgUdpSlavePort#
The UDP port used by the Slave. The default value is 0 (any unused port available).
int ArgUdpPort#
The UDP port value set by the command line argument "-sync_port".
string ArgMasterAddress#
The IP address of the Master.
string ArgMulticastAddress#
The Multicast address of the Master. The default value is 239.0.0.1
string ArgBroadcastAddress#
The Broadcast address of the Master.
int ArgPeersCount#
The Number of peers. The default value is 1. The number of peers includes all Slaves in the network + the Master.
bool ArgSwapSyncMode#
The
Syncker.ADDRESSING_METHOD ArgAddressingMethod#
The Current addressing mode: one of the ADDRESSING_METHOD enum values.
bool ArgIsMaster#
The A value indicating if the command line argument "-sync_master" equals to 1.
bool ArgInitSyncker#
The A value indicating if the command line argument "-sync_init" equals to 1.
Members
bool GetArgInitSyncker ( ) #
Returns a value indicating if the command line argument "-sync_init" equals to 1.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.Syncker.SWAP_SYNC_MODE GetArgSwapSyncMode ( ) #
Returns the swap synchronization mode set by the command line argument "-sync_swap".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.1string GetArgMasterAddress ( ) #
Returns the IP address of the Master set by the command line argument "-sync_master_address".Notice
Available for Slave only.
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".Notice
Available for Slave only.
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".Notice
Available for Slave only.
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 ( int peers_count, string broadcast_address, ushort udp_port, Syncker.SWAP_SYNC_MODE swap_mode = Syncker.SWAP_SYNC_MODE.DEFAULT ) #
Initializes the Syncker as the Master application with the broadcast mode enabled.Notice
Slaves must be initialized with broadcast mode enabled as well.
Arguments
- 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.
- Syncker.SWAP_SYNC_MODE swap_mode - Swap synchronization mode to be used by the Syncker. Similar to specifying the -sync_swap command-line argument.
Return value
Master InitMasterMulticast ( int peers_count, string multicast_address, ushort udp_port, Syncker.SWAP_SYNC_MODE swap_mode = Syncker.SWAP_SYNC_MODE.DEFAULT ) #
Initializes the Syncker as the Master application with the multicast mode enabled.Arguments
- 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.
- Syncker.SWAP_SYNC_MODE swap_mode - Swap synchronization mode to be used by the Syncker. Similar to specifying the -sync_swap command-line argument.
Return value
Master InitMasterUnicast ( int peers_count, ushort udp_port, Syncker.SWAP_SYNC_MODE swap_mode = Syncker.SWAP_SYNC_MODE.DEFAULT ) #
Initializes the Syncker as the Master application with the broadcast mode enabled.Notice
Slaves must be initialized with broadcast mode enabled as well.
Arguments
- 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.
- Syncker.SWAP_SYNC_MODE swap_mode - Swap synchronization mode to be used by the Syncker. Similar to specifying the -sync_swap 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.Notice
Called automatically, when the plugin is unloaded.
Slave InitSlaveBroadcast ( ushort udp_port, Syncker.SWAP_SYNC_MODE swap_mode = Syncker.SWAP_SYNC_MODE.DEFAULT ) #
Initializes the Syncker as the Slave application with the broadcast mode enabled. Master's IP address will be detected automatically.Notice
Master must be initialized with broadcast mode enabled as well.
Arguments
- ushort udp_port - UDP port to be used. Similar to specifying the -sync_port command-line argument.
- Syncker.SWAP_SYNC_MODE swap_mode - Swap synchronization mode to be used by the Syncker. Similar to specifying the -sync_swap command-line argument.
Return value
Slave interface instance.Slave InitSlaveBroadcast ( string master_address, ushort udp_port, Syncker.SWAP_SYNC_MODE swap_mode = Syncker.SWAP_SYNC_MODE.DEFAULT ) #
Initializes the Syncker as the Slave application with the specified parameters and the broadcast mode enabled. Master's IP address is specified explicitly.Notice
Master must be initialized with broadcast mode enabled as well.
Arguments
- 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.
- Syncker.SWAP_SYNC_MODE swap_mode - Swap synchronization mode to be used by the Syncker. Similar to specifying the -sync_swap command-line argument.
Return value
Slave interface instance.Slave InitSlaveMulticast ( string multicast_address, ushort udp_port, Syncker.SWAP_SYNC_MODE swap_mode = Syncker.SWAP_SYNC_MODE.DEFAULT ) #
Initializes the Syncker as the Slave application with the specified parameters and the multicast mode enabled. Master's IP address will be detected automatically.Notice
Master must be initialized with broadcast mode enabled as well.
Arguments
- 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.
- Syncker.SWAP_SYNC_MODE swap_mode - Swap synchronization mode to be used by the Syncker. Similar to specifying the -sync_swap command-line argument.
Return value
Slave interface instance.Slave InitSlaveMulticast ( string master_address, string multicast_address, ushort udp_port, Syncker.SWAP_SYNC_MODE swap_mode = Syncker.SWAP_SYNC_MODE.DEFAULT ) #
Initializes the Syncker as the Slave application with the specified parameters and the multicast mode enabled. Master's IP address is specified explicitly.Notice
Master must be initialized with broadcast mode enabled as well.
Arguments
- 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.
- Syncker.SWAP_SYNC_MODE swap_mode - Swap synchronization mode to be used by the Syncker. Similar to specifying the -sync_swap command-line argument.
Return value
Slave interface instance.Slave InitSlaveUnicast ( ushort master_udp_port, ushort slave_udp_port = 0, Syncker.SWAP_SYNC_MODE swap_mode = Syncker.SWAP_SYNC_MODE.DEFAULT ) #
Initializes the Syncker as the Slave application with the specified parameters and the unicast mode enabled. Master's IP address will be detected automatically.Notice
Master must be initialized with broadcast mode enabled as well.
Arguments
- 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.
- Syncker.SWAP_SYNC_MODE swap_mode - Swap synchronization mode to be used by the Syncker. Similar to specifying the -sync_swap command-line argument.
Return value
Slave interface instance.Slave InitSlaveUnicast ( string master_address, ushort master_udp_port, ushort slave_udp_port = 0, Syncker.SWAP_SYNC_MODE swap_mode = Syncker.SWAP_SYNC_MODE.DEFAULT ) #
Initializes the Syncker as the Slave application with the specified parameters and the unicast mode enabled. Master's IP address is specified explicitly.Notice
Master must be initialized with broadcast mode enabled as well.
Arguments
- 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.
- Syncker.SWAP_SYNC_MODE swap_mode - Swap synchronization mode to be used by the Syncker. Similar to specifying the -sync_swap 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.Last update:
2024-07-12
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)