MultiUserManager Class Reference

MultiUserManager is the entry point to all Multiuser functionalities. More...

Public Member Functions
bool	startServer (int, QString)
	Starts the Multiuser server with the specified port number and password. More...
bool	stopServer ()
	Stops the Multiuser server. More...
bool	isServerStarted ()
	Returns true if the Multiuser server is started, otherwise false. More...
int	getPortNumber ()
	Returns the port number the Multiuser server is listening on. More...
void	setPassword (QString)
	Sets the password for the Multiuser server. More...
QString	getPassword ()
	Returns the password for the Multiuser server. More...
void	setAcceptMode (AcceptMode)
	Sets the existing remote networks accept mode. More...
AcceptMode	getAcceptMode ()
	Returns the existing remote networks accept mode. More...
void	setNewRNetAcceptMode (AcceptMode)
	Sets the new remote networks accept mode. More...
AcceptMode	getNewRNetAcceptMode ()
	Returns the new remote networks accept mode. More...
int	getRemoteNetworkCount ()
	Returns the number of remote networks on the workspace. More...
RemoteNetwork	getRemoteNetworkAt (int)
	Returns the remote network at the specified index. More...
RemoteNetwork	getRemoteNetworkByName (QString)
	Returns the remote network with the specified name. More...
QString	getListeningAddresses ()
	Returns the IP addresses the Multiuser server is listening on. More...
void	writeUdpDatagram ()
	Sends a UDP datagram over the Multiuser connection. More...
QString	getMulticastSenderIp ()
	Returns the source IP address of the multicast datagram. More...

Detailed Description

MultiUserManager is the entry point to all Multiuser functionalities.

Member Function Documentation

getAcceptMode()

AcceptMode MultiUserManager::getAcceptMode

(

)

Returns the existing remote networks accept mode.

Returns

enum<AcceptMode>, the accept mode. Modes: eAlwaysAccept = 0, eAlwaysDeny = 1, ePrompt = 2

getListeningAddresses()

QString MultiUserManager::getListeningAddresses

(

)

Returns the IP addresses the Multiuser server is listening on.

Returns

QString, the IP addresses the Multiuser server is listening on.

getMulticastSenderIp()

QString MultiUserManager::getMulticastSenderIp

(

)

Returns the source IP address of the multicast datagram.

Returns

QString, the source IP address of the multicast datagram.

getNewRNetAcceptMode()

AcceptMode MultiUserManager::getNewRNetAcceptMode

(

)

Returns the new remote networks accept mode.

Returns

enum<AcceptMode>, the accept mode. Modes: eAlwaysAccept = 0, eAlwaysDeny = 1, ePrompt = 2

getPassword()

QString MultiUserManager::getPassword

(

)

Returns the password for the Multiuser server.

Returns

QString, the password for the Multiuser server.

getPortNumber()

int MultiUserManager::getPortNumber

(

)

Returns the port number the Multiuser server is listening on.

Returns

int, the port number the Multiuser server is listening on.

getRemoteNetworkAt()

RemoteNetwork MultiUserManager::getRemoteNetworkAt

(

int

)

Returns the remote network at the specified index.

Parameters

index,the

index of the remote network of interest.

Returns

RemoteNetwork, the RemoteNetwork object at the specified index.

getRemoteNetworkByName()

RemoteNetwork MultiUserManager::getRemoteNetworkByName

(

QString

)

Returns the remote network with the specified name.

Parameters

name,the

name of the remote network of interest.

Returns

RemoteNetwork, the RemoteNetwork object with the specified name.

getRemoteNetworkCount()

int MultiUserManager::getRemoteNetworkCount

(

)

Returns the number of remote networks on the workspace.

Returns

int, the number of remote networks on the workspace.

isServerStarted()

bool MultiUserManager::isServerStarted

(

)

Returns true if the Multiuser server is started, otherwise false.

Returns

bool, true if the Multiuser server is started, otherwise false.

setAcceptMode()

void MultiUserManager::setAcceptMode

(

AcceptMode

)

Sets the existing remote networks accept mode.

Parameters

acceptMode,the

accept mode. Modes: eAlwaysAccept = 0, eAlwaysDeny = 1, ePrompt = 2

setNewRNetAcceptMode()

void MultiUserManager::setNewRNetAcceptMode

(

AcceptMode

)

Sets the new remote networks accept mode.

Parameters

acceptMode,the

accept mode. Modes: eAlwaysAccept = 0, eAlwaysDeny = 1, ePrompt = 2

setPassword()

void MultiUserManager::setPassword

(

QString

)

Sets the password for the Multiuser server.

Parameters

password,the

password for Multiuser server.

startServer()

bool MultiUserManager::startServer	(	int	,
		QString
	)

Starts the Multiuser server with the specified port number and password.

Parameters

portNumber,the	port number to listen on.
password,password.

Returns

bool, true if successful, otherwise false.

stopServer()

bool MultiUserManager::stopServer

(

)

Stops the Multiuser server.

Returns

bool, true if successful, otherwise false.

writeUdpDatagram()

void MultiUserManager::writeUdpDatagram

(

)

Sends a UDP datagram over the Multiuser connection.

---

The documentation for this class was generated from the following file:

• CMUManager.pki