Locking mechanism for IServer. More...

#include "api/server_lock.h"

Public Member Functions
	CServerLock (IServer *server)
	Internal use only. Use CIntegraSession to obtain a CServerLock.

IServer &	operator* ()
	Indirection operator. Allows CServerLock to be used as if it were an IServer.

IServer *	operator-> ()
	Defererence operator. Allows CServerLock pointer to be used as if it were an IServer pointer.

Detailed Description

Locking mechanism for IServer.

Users of libIntegra api should only call methods on IServer when exactly one CServerLock instance exists. This is because all the methods of IServer assumes that the server is locked. The way to do this is as follows:

1) Obtain a CServerLock from CIntegraSession each time you need to interact with libIntegra

2) Use CServerLock::operator-> and CServerLock::operator* to call IServer methods

3) Ensure that the CServerLock is destroyed as soon as you are finished with it, typically by declaring it as a local variable which falls out of scope

Example 1 (code block): { CServerLock server = m_integra_session.get_server(); server.do_something(); }

Example 2 (inline):

m_integra_session.get_server().do_something();

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

/Users/jamie/Documents/IntegraLive/libIntegra/api/server_lock.h

Public Member Functions

Detailed Description