This class lets you define dynamic view servers. More...

#include <ilserver/mvserver.h>

Inheritance diagram for IlsMvServer:

Public Types
enum	ThreadMode { ILS_SINGLE_THREAD , ILS_THREADED_SEND, ILS_THREAD_SAFE_TRANS, ILS_THREADED_DEFAULT }
	possible execution modes of the server More...

Public Member Functions
virtual IlsBoolean	processRequest (IlsTime *t)
	Handles a request. More...

View Handling
virtual void	onOpenView (IlsMvView &)
	Called each time a new dynamic view is opened. More...

virtual void	onCloseView (IlsMvView &)
	Called each time a view is closed on the server. More...

Transaction Control
The way a dynamic view server processes a component transaction can be controlled both on the component side and on the server side. On the component side, the status passed to the function `IlsMvComponent::commitC2STransaction()` allows you to indicate whether the server must: acknowledge the transaction or not; roll back the transaction or not when an update fails; execute a notification cycle or not if the transaction is successful. On the server side, the virtual functions `beginTransaction()` and `endTransaction()` are called before and after the component transaction request has been executed. These functions interpret the status of the component transaction along with the thread mode that was used to initialize the server. The resulting decisions are: First, whether a Server transaction will be created or not; Then, whether a notification cycle will take place or not if the transaction is created and successful.
virtual IlsBoolean	beginTransaction (IlsMvComponentItf &comp, IlsTransactionId tId, IlsC2STransStatus tStat)
	This virtual member function is executed by Server at the beginning of a transaction that was opened by the component. More...

virtual IlsBoolean	endTransaction (IlsMvComponentItf &comp, IlsTransactionId tId, IlsC2STransStatus tStat, IlsBoolean res)
	This virtual member function is executed by Server at the end of a transaction that was opened by the component. More...

Static Public Member Functions
static IlsBoolean	AbortTransaction ()
	Instructs the server to abort a component transaction handled by the server. More...

static void	CreateDefaultCompAtStartup (IlsBoolean b)
	Change creation of default component at startup. More...

static IlsMvUser *	GetDefaultUser ()
	Returns the user associated with the default component that is linked to the server. More...

static IlsMvServer &	GetSingleton ()
	Retrieves a reference of the unique instance of the dynamic view server that has been initialized in the application. More...

static void	Notify ()
	Performs notification and/or re-evaluation during an interaction cycle. More...

static void	ReplyMessage (const IlsMvMessage::SvMsg &msg, IlsBoolean local=IlsFalse)
	Send a message of type `IlsMvMessage::SvMsg` to the component that sent the transaction currently processed by the server. More...

static void	SetCatchExceptionMode ()
	Enable exception mode. More...

static void	UnsetCatchExceptionMode ()
	Disable exception mode. More...

Initialization
static IlsBoolean	Initialize (int &argc, char **argv, int threadMode=ILS_THREADED_DEFAULT)
	Initialization of `IlsMvServer`. More...

Loading Dynamic View Types Specifications
static IlsBoolean	LoadResources (IlsString resourceFile)
	Loads a resource file that contains a list of dynamic view type specification files. More...

static IlsBoolean	LoadViewSpec (IlsString ilsFile, IlsBoolean useXmlParser=IlsFalse)
	Loads a dynamic-view type specification file on the server. More...

static IlsBoolean	InterpretViewSpec (IlsString viewSpec, IlsMvComponentItf *compItf=0, IlsBoolean useXmlParser=IlsFalse)
	Interprets the dynamic-view type specification passed by the `viewSpec` parameter. More...

Opening Views
Dynamic views are generally opened from an application component (see the function `IlsMvComponent::openView()`). The following static member functions let you open a view from the server.
static IlsMvView *	OpenView (const IlsString &objId, const IlsString &viewId, IlsMvComponentItf compItf=0, const IlsMvValue params=0, unsigned long paramsNb=0, IlsBoolean force=IlsFalse, IlsOpenViewStatus *status=0)
	Opens the dynamic view whose label is passed as its second parameter on the object whose label is provided as its first parameter. More...

static IlsMvView *	OpenView (IlsViewed obj, const IlsString &viewId, IlsMvComponentItf compItf=0, const IlsMvValue params=0, unsigned long paramsNb=0, IlsBoolean force=IlsFalse, IlsOpenViewStatus status=0)
	Similar to the previous one, except that it takes a pointer to a Server object, instead of an object identifier, as its first argument. More...

Trace Mode
static void	SetTrace (IlsBoolean status=IlsTrue)
	Activates the trace mode of the server. More...

static IlsBoolean	IsTraced ()
	Returns `IlsTrue` if the server is operating in trace mode.

static void	SetTraceTime (IlsBoolean status=IlsTrue)
	Enable or disable time-tracing mode. More...

static IlsBoolean	IsTracedTime ()
	Returns `IlsTrue` if time tracing-mode is enabled.

Identifying Objects
static IlsBoolean	DeclObjectLabel (IlsViewed &obj, IlsString label)
	Associates a label with a server object and stores the association in the server. More...

static IlsString	GetLabelOfObject (IlsViewed &object)
	Returns the label assigned to an object. More...

static IlsViewed *	GetObjectFromLabel (IlsString label)
	Returns the Server object with which the string label is associated. More...

static IlsBoolean	UndeclObjectLabel (IlsViewed &object)
	Breaks the association established between the Server object object and a label, if any. More...

static IlsBoolean	UndeclObjectLabel (IlsString label)
	Breaks any association established between `label` and a server object. More...

Protected Member Functions
	IlsMvServer (int threadMode=0)
	This protected constructor is implicitly called when the dynamic view server is initialized. More...

Friends
class	IlsMvComponentItf

class	IlsMvServerFactory

class	IlsMvView

Component Connection
virtual void	onConnect (IlsMvComponentItf &compItf)
	Called each time a new component connects to the server. More...

virtual void	onDisconnect (IlsMvComponentItf &compItf)
	Called when a component disconnects from the server —that is, when the component interface compItf is deleted. More...

virtual IlsBoolean	acceptConnection (IlsMvComponentItf &compItf, IlsString &cause)
	alled before the method `onConnect()` but after the user has been created and bound (see `IlsMvUsr::onBind()`). More...

static IlsMvComponentItf *	GetComponent (IlsMvComponentId id)
	Returns the component identified by id. More...

static IlsMvComponentItf const	GetComponents (int &dim)
	Returns an array of all the components that are currently connected to the server. More...

Execution Loop
virtual void	beginNotification ()
	If you override this virtual member function, you must call the inherited function.

virtual void	endNotification ()
	If you override this virtual member function, you must call the inherited function.

void	registerEndCycleTask (IlsCallbackFunc cb, IlsAny arg)
	Register a callback which will be executed at the end of the notification cycle. These callbacks are executed only once and are unregistered after execution. More...

static IlsBoolean	Run (int nb=0, IlsTime *t=0)
	Runs the execution loop of a dynamic view server. More...

static void	Stop ()
	Interrupts the execution loop once the current interaction cycle is over.

Interactors
virtual IlsMvUser *	getInteractingUser ()
	Returns the user associated with the interface of the component that issued the request handled during the current interaction cycle. More...

static IlsMvComponentItf *	GetDefaultComp ()
	Returns a pointer to the interface of the default component that is implicitly created by Server when a view is opened with no associated component. More...

static IlsMvComponentItf *	GetInteractor ()
	Returns a pointer to the interface of the component that issued the request handled during the current interaction cycle. More...

static IlsMvUser *	GetInteractingUser ()
	Returns the current interacting user by calling the virtual function `getInteractingUser()`.

static IlsMvView *	GetInteractingView ()
	Retrieves the interacting view while an update request from a component is processed by the server. More...

Detailed Description

This class lets you define dynamic view servers.

<>:</>

In a dynamic view server, views are loaded at runtime from dynamic view type specifications.

See also: IlsMvComponent, IlsMvComponentItf, IlsMvMessage, IlsTransaction.

Member Enumeration Documentation

◆ ThreadMode

enum IlsMvServer::ThreadMode

possible execution modes of the server

Enumerator
ILS_SINGLE_THREAD	The server runs in a single thread and is not multithread safe
ILS_THREADED_SEND	The server is multithread safe. A thread is started for each component to send representation updates to the component. This mode is interesting if the server interacts with remote components because the server does not have to wait for the communication layer to send updates.
ILS_THREAD_SAFE_TRANS	This mode tells ILOG Server to create a Server transaction systematically each time a component transaction is processed, so as to allow concurrent transactions to be safely processed in other threads (see the member function `beginTransaction()`). As the use of Server transactions impacts the performance of object access and modifications, this mode should be selected only when really necessary.
ILS_THREADED_DEFAULT	When the threadMode parameter is set to this value, the mode `ILS_SINGLE_THREAD` is automatically selected, unless one of the environment variables `ILS_THREADED_SEND` or `ILS_THREADED_SAFE_TRANS` is set. Each of these variables selects the corresponding mode.

Constructor & Destructor Documentation

◆ IlsMvServer()

IlsMvServer::IlsMvServer ( int threadMode = 0 )

protected

This protected constructor is implicitly called when the dynamic view server is initialized.

The dynamic view server is actually created during this initialization phase by the current instance of IlsMvServerFactory. Only one dynamic view server can exist at a given time. The threadMode parameter specifies the execution mode of the server.

See also: IlsMvServerFactory::newInstance().

Parameters

threadMode execution mode of the server

Member Function Documentation

◆ AbortTransaction()

static IlsBoolean IlsMvServer::AbortTransaction ( )

static

Instructs the server to abort a component transaction handled by the server.

This transaction will be rolled back both on the server side and on the component side. This function returns IlsTrue, unless the server was not processing a component transaction.

Returns: IlsTrue, unless the server was not processing a component transaction.

◆ acceptConnection()

virtual IlsBoolean IlsMvServer::acceptConnection	(	IlsMvComponentItf &	compItf,
		IlsString &	cause
	)

virtual

alled before the method onConnect() but after the user has been created and bound (see IlsMvUsr::onBind()).

At this point, you can accept the connection by returning true or reject it by returning false. If you reject the connection, the component is disconnected and a connection error message is sent to the component (see IlsMvComponent::connectionDenied()). In this case, you should set the cause parameter to explain why you rejected the connection. If you accept the connection, you can set the cause parameter that will be given back to the component (see IlsMvComponent::connectionAllowed()).

Note that this method is not called for the default component. A default linked component is automatically created when a server starts handling linked views opened on the server.

Parameters

compItf	componentItf
cause	this value must be set to explain why you reject or accept the connection

Returns: IlsTrue if the connection is accepted. IlsFalse otherwise.

◆ beginTransaction()

virtual IlsBoolean IlsMvServer::beginTransaction	(	IlsMvComponentItf &	comp,
		IlsTransactionId	tId,
		IlsC2STransStatus	tStat
	)

virtual

This virtual member function is executed by Server at the beginning of a transaction that was opened by the component.

When this function is not overridden, it implicitly creates a Server transaction, except if:

The flag ILS_C2S_NO_ROLLBACK is set in the parameter tStat, and
The thread-safe transaction mode has not been selected at server initialization. (See the IlsMvServer constructor.)

Parameters

comp	identifies the component interface
tId	the identifier of the transaction
tStat	the status of the transaction as assigned by the component (see the member function `IlsMvComponent::commitC2STransaction()`)

Returns: returning IlsFalse will roll back the transaction on the component side.

◆ CreateDefaultCompAtStartup()

static void IlsMvServer::CreateDefaultCompAtStartup ( IlsBoolean b )

static

Change creation of default component at startup.

By default, Server instantiates the default component used for linked views at startup. Use this function if you need to change the default behavior.

◆ DeclObjectLabel()

static IlsBoolean IlsMvServer::DeclObjectLabel	(	IlsViewed &	obj,
		IlsString	label
	)

static

Associates a label with a server object and stores the association in the server.

Using this association, an application component can open a view by using the object label as a parameter. The application component can also query the server to obtain a list of labels that match a given pattern. For details, see the functions IlsMvComponent::openView() and IlsMvComponent::getObjectIds().

This member function returns IlsFalse if the object has already an associated label or if the specified label already has been assigned to another object. If at least one view has subscribed to the object, the association is automatically broken when the server object is suppressed or cut. It is up to the user to undeclare and redeclare the association each time the label has to be changed.

Parameters

obj	object to be associated with a label
label	label associated to the object

Returns: IlsFalse if the object has already an associated label or if the specified label already has been assigned to another object

◆ endTransaction()

virtual IlsBoolean IlsMvServer::endTransaction	(	IlsMvComponentItf &	comp,
		IlsTransactionId	tId,
		IlsC2STransStatus	tStat,
		IlsBoolean	res
	)

virtual

This virtual member function is executed by Server at the end of a transaction that was opened by the component.

This function takes the following parameters:

The comp parameter .
The tId parameter is .
The tStat parameter is .

When this function is not overridden, it executes the following instructions, depending on the values of the tStat and res parameters:

When res is set to IlsTrue or ILS_C2S_NO_ROLLBACK is set in tStat parameter:
- If a Server transaction was implicitly created in beginTransaction(), this transaction is committed.
- If the value ILS_C2S_NO_NOTIFY is not set in the tStat parameter, a notification cycle is executed.
Otherwise, if a transaction was implicitly created in the function beginTransaction, this transaction is rolled back. No notification cycle is executed.
In any other case, nothing happens.

Parameters

comp	identifies the component interface
tId	the identifier of the transaction
tStat	the status of the transaction as assigned by the component (See the member function `IlsMvComponent::commitC2STransaction()`)
res	specifies the results of the transaction execution

Returns

this function returns the value of the parameter res.

When this function returns IlsFalse and the tStat parameter is not set to ILS_C2S_NO_ROLLBACK, the transaction is rolled back on the component side.
When this function returns IlsTrue and the tStat parameter is not set to ILS_C2S_NO_ACKNOWLEDGE, the transaction is acknowledged on the component side.

◆ GetComponent()

static IlsMvComponentItf* IlsMvServer::GetComponent ( IlsMvComponentId id )

static

Returns the component identified by id.

Parameters

id	id of the component

Returns: component identified by id or null if the component has already been disconnected

◆ GetComponents()

static IlsMvComponentItf* const* IlsMvServer::GetComponents ( int & dim )

static

Returns an array of all the components that are currently connected to the server.

Parameters

dim	receive the size of the array

Returns: array of components. The array may contain holes (that is, null entries) corresponding to components that have already been disconnected. This array is managed by Rogue Wave Server internally. You must not delete it.

◆ GetDefaultComp()

static IlsMvComponentItf* IlsMvServer::GetDefaultComp ( )

static

Returns a pointer to the interface of the default component that is implicitly created by Server when a view is opened with no associated component.

The default component is local to the server. See the member functions OpenView() for more information.

By default this function returns a null pointer.

◆ GetDefaultUser()

static IlsMvUser* IlsMvServer::GetDefaultUser ( )

static

Returns the user associated with the default component that is linked to the server.

This function return null if the default component has not yet been initialized. See also the static member function GetDefaultComp().

◆ getInteractingUser()

virtual IlsMvUser* IlsMvServer::getInteractingUser ( )

virtual

Returns the user associated with the interface of the component that issued the request handled during the current interaction cycle.

It returns a null pointer if no interaction cycle is in progress.

◆ GetInteractingView()

static IlsMvView* IlsMvServer::GetInteractingView ( )

static

Retrieves the interacting view while an update request from a component is processed by the server.

The interactive view is set if the update is initialized at representation-object level (see IlsRpObject::onUpdate() or execCallback()).

Returns: the interacting view

◆ GetInteractor()

static IlsMvComponentItf* IlsMvServer::GetInteractor ( )

static

Returns a pointer to the interface of the component that issued the request handled during the current interaction cycle.

It returns a null pointer if no interaction cycle is in progress.

◆ GetLabelOfObject()

static IlsString IlsMvServer::GetLabelOfObject ( IlsViewed & object )

static

Returns the label assigned to an object.

Parameters

object object for which you request the label

Returns: label assigned to an object or null string if object has no label

◆ GetObjectFromLabel()

static IlsViewed* IlsMvServer::GetObjectFromLabel ( IlsString label )

static

Returns the Server object with which the string label is associated.

Parameters

label label of the object

Returns: pointer to the object associated with the label

◆ GetSingleton()

static IlsMvServer& IlsMvServer::GetSingleton ( )

static

Retrieves a reference of the unique instance of the dynamic view server that has been initialized in the application.

An error message is issued if this method is invoked before the server has been initialized.

◆ Initialize()

static IlsBoolean IlsMvServer::Initialize	(	int &	argc,
		char **	argv,
		int	threadMode = `ILS_THREADED_DEFAULT`
	)

static

Initialization of IlsMvServer.

A dynamic view server must be initialized before it can make use of other functions provided by the IlsMvServer API. Initialization must take place after the static member function IlsMvProcess::Initialize(), or that of a derived class, has been called. This static member function takes the arguments of the command line as its parameters. It extracts and parses the following arguments:

-ilsr or -ilsres filename

These options load a resource file by executing the member function IlsMvServer::LoadResources(), which takes the name of the resource file as its parameter.
-ilsd or -ilsdef filename

These options load a dynamic view type specification file by executing the member function IlsMvServer::LoadViewSpec(), which takes the name of the view specification file as its parameter.

The threadMode parameter specifies the execution mode of the server. Refer to the protected IlsMvServer constructor for details about the various execution modes.

◆ InterpretViewSpec()

static IlsBoolean IlsMvServer::InterpretViewSpec	(	IlsString	viewSpec,
		IlsMvComponentItf *	compItf = `0`,
		IlsBoolean	useXmlParser = `IlsFalse`
	)

static

Interprets the dynamic-view type specification passed by the viewSpec parameter.

If the specification is valid, it is registered with the server. If another specification with the same name has already been registered, it is replaced by the new one.

The argument compItf is a pointer to a component interface. If this pointer is non-null, the error or information messages produced by the view interpreter are sent to the component (see the function IlsMvComponent::recvMessage()).

The parameter useXmlParser specifies to use the XML parser.

This function returns IlsTrue if the string viewSpec contains a valid dynamic-view type specification. Otherwise, it returns IlsFalse.

Dynamic views are generally opened from an application component (see the function IlsMvComponent::openView()). The following static member functions let you open a view from the server.

Parameters

viewSpec	`IlsString` that contains the view specification
compItf	a pointer to a component interface
useXmlParser	`IlsTrue` for XML description

Returns: IlsTrue if viewSpec contains a valid view specification

◆ LoadResources()

static IlsBoolean IlsMvServer::LoadResources ( IlsString resourceFile )

static

Loads a resource file that contains a list of dynamic view type specification files.

For each one of these files, it executes the member function IlsMvServer::LoadViewSpec() by passing the specification file name as a parameter. The resource file is located by means of the access paths specified by the environment variable ILSPATH. This member function returns IlsTrue if the file is found. Otherwise, it returns IlsFalse.

Parameters

resourceFile resource file name

Returns: IlsTrue if the file is found. IlsFalse otherwise.

◆ LoadViewSpec()

static IlsBoolean IlsMvServer::LoadViewSpec	(	IlsString	ilsFile,
		IlsBoolean	useXmlParser = `IlsFalse`
	)

static

Loads a dynamic-view type specification file on the server.

If a dynamic-view type specification with the same name has already been loaded, it is replaced with the new one. The dynamic-view type specification file is located by means of the access paths specified by the environment variable ILSPATH. This member function returns IlsTrue if the file is found and the dynamic-view type specification is valid. Otherwise, it returns IlsFalse. The parameter useXmlParser specifies to use the XML parser.

Parameters

ilsFile	view specicication file name
useXmlParser	`IlsTrue` if the file is in XML format

Returns: IlsTrue if the file is found. IlsFalse otherwise.

◆ Notify()

static void IlsMvServer::Notify ( )

static

Performs notification and/or re-evaluation during an interaction cycle.

You can use it to start a notification cycle manually for a dynamic view server – for instance, when some actions are performed on the model outside any transaction, because in that case, notification is not automatic.

This function carries out the following steps sequentially:

It reevaluates each derived data member that is marked as out-of-date.
It synchronizes the beginning of notification for all views and components running in their own threads.
It notifies the component that origins and other objects to which the associated view subscribes have been updated since the last notification phase. Notification follows the order in which updates occurred.
It synchronizes the end of notification for all views and components running in their own threads.
It deletes smart pointers created by the notification engine to point to the server objects that were updated during the interaction cycle. If the notification engine is the last one to keep a smart pointer to an object, deleting this smart pointer will destroy the object to which it points. This may cause relations to break and consequently it may requires updates of other objects. In this case, the notification phase loops until all updates are performed.

◆ onCloseView()

virtual void IlsMvServer::onCloseView ( IlsMvView & )

virtual

Called each time a view is closed on the server.

It does nothing, but can be overridden.

◆ onConnect()

virtual void IlsMvServer::onConnect ( IlsMvComponentItf & compItf )

virtual

Called each time a new component connects to the server.

If the server execution mode is set to ILS_THREADED_SEND, this function creates a thread that sends the updates to the component.

This function can be overridden. See the IlsMvServer constructor for details about the various execution modes.

Parameters

compItf the interface of the connected component

◆ onDisconnect()

virtual void IlsMvServer::onDisconnect ( IlsMvComponentItf & compItf )

virtual

Called when a component disconnects from the server —that is, when the component interface compItf is deleted.

It does nothing but can be overridden.

Parameters

compItf deleted component interface

◆ onOpenView()

virtual void IlsMvServer::onOpenView ( IlsMvView & )

virtual

Called each time a new dynamic view is opened.

By default, this function has no effect. It can be overridden.

◆ OpenView() [1/2]

static IlsMvView* IlsMvServer::OpenView	(	const IlsString &	objId,
		const IlsString &	viewId,
		IlsMvComponentItf *	compItf = `0`,
		const IlsMvValue *	params = `0`,
		unsigned long	paramsNb = `0`,
		IlsBoolean	force = `IlsFalse`,
		IlsOpenViewStatus *	status = `0`
	)

static

Opens the dynamic view whose label is passed as its second parameter on the object whose label is provided as its first parameter.

Parameters

objId	name of the object origin of the view
viewId	name of the view to open
compItf	A representation of the view is created in the component identified by the interface address compItf. If the address is null, the representation of the view is created in a default local component created by the server.
params	an array of `IlsMvValue`. It can be null. The values, if any, contained in this array are assigned to the dynamic view parameters on a sequential basis. When a value is void, it is discarded.
paramsNb	the number of parameters in the params value array.
force	If set to `IlsTrue`, this argument forces the opening of the view, even if this view has already been opened by the component (and is still opened). The default value is `IlsFalse`, which means that the view is not duplicated.
status	When the value pointed to by this parameter is a non-null pointer, that value is assigned the status of the view-opening action. See the type definition `IlsOpenViewStatus` for more information on the possible values.

Returns

a pointer to the new view or to the existing view if the following conditions are met:

objId is associated with a Server object.
viewId is the name of a view specification loaded in the server.
The type of the Server object is compatible with the type specified as the view origin.

Otherwise, the function returns the null pointer.

◆ OpenView() [2/2]

static IlsMvView* IlsMvServer::OpenView	(	IlsViewed *	obj,
		const IlsString &	viewId,
		IlsMvComponentItf *	compItf = `0`,
		const IlsMvValue *	params = `0`,
		unsigned long	paramsNb = `0`,
		IlsBoolean	force = `IlsFalse`,
		IlsOpenViewStatus *	status = `0`
	)

static

Similar to the previous one, except that it takes a pointer to a Server object, instead of an object identifier, as its first argument.

Parameters

obj	pointer to the object origin of the view. If the pointer is null, the view is created with no origin.
viewId	name of the view to open
compItf	A representation of the view is created in the component identified by the interface address compItf. If the address is null, the representation of the view is created in a default local component created by the server.
params	an array of `IlsMvValue`. It can be null. The values, if any, contained in this array are assigned to the dynamic view parameters on a sequential basis. When a value is void, it is discarded.
paramsNb	the number of parameters in the params value array.
force	If set to `IlsTrue`, this argument forces the opening of the view, even if this view has already been opened by the component (and is still opened). The default value is `IlsFalse`, which means that the view is not duplicated.
status	When the value pointed to by this parameter is a non-null pointer, that value is assigned the status of the view-opening action. See the type definition `IlsOpenViewStatus` for more information on the possible values.

Returns

a pointer to the new view or to the existing view if the following conditions are met:

obj is a pointer to an existing Server object.
viewId is the name of a view specification loaded in the server.
The type of the Server object is compatible with the type specified as the view origin.

Otherwise, the function returns the null pointer.

◆ processRequest()

virtual IlsBoolean IlsMvServer::processRequest ( IlsTime * t )

virtual

Handles a request.

It calls the virtual function IlsMvProcess::processRequest().

◆ registerEndCycleTask()

void IlsMvServer::registerEndCycleTask	(	IlsCallbackFunc	cb,
		IlsAny	arg
	)

Register a callback which will be executed at the end of the notification cycle. These callbacks are executed only once and are unregistered after execution.

If such callbacks modify the server model, you should restart a new notification cycle by calling the static member function IlsMvServer::Notify().

Parameters

cb	callback to call
arg	user argument

◆ ReplyMessage()

static void IlsMvServer::ReplyMessage	(	const IlsMvMessage::SvMsg &	msg,
		IlsBoolean	local = `IlsFalse`
	)

static

Send a message of type IlsMvMessage::SvMsg to the component that sent the transaction currently processed by the server.

See the GetInteractor() function for details.

The virtual member function IlsMvComponent::recvMessage() * will be executed on the component side.

◆ Run()

static IlsBoolean IlsMvServer::Run	(	int	nb = `0`,
		IlsTime *	t = `0`
	)

static

Runs the execution loop of a dynamic view server.

The execution loop is also interrupted if the member function processRequest() executed during an interaction cycle returns IlsFalse.

An interaction cycle executes the following phases sequentially:

Begin the interaction cycle: The interaction cycle starts with a call to the virtual function IlsViewServer::beginInteractionCycle(). If this member function returns IlsFalse, the execution loop ends.
Execute an action: The member function processRequest() is called to execute an action. Any viewed object or viewed list of objects modified by an action is marked as requiring notification. The reference counter of every viewed object that has been marked is incremented to prevent these objects from being deleted before the notification phase. If the function processRequest() returns IlsFalse, the interaction cycle is stopped before the notification phase is executed, and the execution loop terminates.
Re-evaluate and notify: These two phases are performed within the member function Notify(), provided automatic notification mode is selected.
- First, all eager derived data members that are marked out-of-date are reevaluated.
- Then notification is carried out.

At the end of notification, the reference counter of each marked object is decremented, and the objects are unmarked. Every object with a null reference counter is destroyed. Viewed objects that are the target of relations owned by destroyed objects are thus modified. They are marked in turn as requiring notification. Consequently, the reevaluation/notification phase loops until all eager derived members are updated and no new viewed object requires notification.

Ends a cycle: A call to the virtual function IlsViewServer::endInteractionCycle() terminates an interaction cycle. If this member function returns IlsFalse, the execution loop stops.

Another technique is to execute an interaction cycle manually. To do so, you have to call the static member function Notify() explicitly after any action performed on viewed objects and after creating or closing a view.

Parameters

nb	number of interaction cycles to be performed as its first argument. If nb equals `0`, the loop will never stop.
t	specifies how long the server will wait for a request to be issued by a component. If the pointer is null, the function loops indefinitely. If no request arrives during this lapse of time, the execution loop exits. Otherwise, the function stops once the specified number of interaction cycles has been executed if nb is a number strictly greater than 0.

Returns: IlsFalse if interrupted by timeout.

◆ SetCatchExceptionMode()

static void IlsMvServer::SetCatchExceptionMode ( )

static

Enable exception mode.

Each time a transaction is committed by a component (see the member function IlsMvComponent::commitC2STransaction()), a transaction is executed at the server level (see the class IlsTransaction).

By default, any instance of IlsException raised by the Server when this transaction is executed is caught and results in the transaction being rolled back both at server and component levels. The static member function UnsetCatchExceptionMode() disables exception-catching mode for subsequent transactions, while the SetCatchExceptionMode() static member function enables the mode again.

◆ SetTrace()

static void IlsMvServer::SetTrace ( IlsBoolean status = IlsTrue )

static

Activates the trace mode of the server.

Trace mode can also be activated by the ILS_TRACE_TIME environment variable.

◆ SetTraceTime()

static void IlsMvServer::SetTraceTime ( IlsBoolean status = IlsTrue )

static

Enable or disable time-tracing mode.

In this mode, timing information are collected and displayed. The following durations are collected:

Process Request: time to process an incoming request
- receiving: time to receive a message on the communication layer (This duration may not be available for all communication layers).
- decoding: time to decode a message and begin to execute the transaction.
- user transaction: time spent between the call to IlsMvServer::beginTransaction() and the call to IlsMvServer::endTransaction().
Notification: duration of the notification cycle. This duration includes the time needed to send messages to the communication layer if ILS_THREADED_SEND mode is not active. However, if this mode is active, Send traces may be interlaced with Notification traces.
Send: time to send a message to the communication layer
- encoding: time to encode the message.
Interaction Cycle: duration of the whole interaction cycle. Corresponds to the time when the server cannot handle a request.

See the ILS_TRACE_TIME environment variable.

◆ UndeclObjectLabel() [1/2]

static IlsBoolean IlsMvServer::UndeclObjectLabel ( IlsString label )

static

Breaks any association established between label and a server object.

As objects are maintained in the association table through smart pointers, this method may delete the object.

Parameters

label label for which you want to break the association

Returns: IlsTrue if an association was found. Otherwise, it returns IlsFalse.

◆ UndeclObjectLabel() [2/2]

static IlsBoolean IlsMvServer::UndeclObjectLabel ( IlsViewed & object )

static

Breaks the association established between the Server object object and a label, if any.

Parameters

object the object for which you want to break the association

Returns: IlsTrue if an association was found. Otherwise, it returns IlsFalse

◆ UnsetCatchExceptionMode()

static void IlsMvServer::UnsetCatchExceptionMode ( )

static

Disable exception mode.

Each time a transaction is committed by a component (see the member function IlsMvComponent::commitC2STransaction()), a transaction is executed at the server level (see the class IlsTransaction).

By default, any instance of IlsException raised by the Server when this transaction is executed is caught and results in the transaction being rolled back both at server and component levels. The static member function UnsetCatchExceptionMode() disables exception-catching mode for subsequent transactions, while the SetCatchExceptionMode() static member function enables the mode again.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Component Connection

Execution Loop

Interactors

Detailed Description

Member Enumeration Documentation

◆ ThreadMode

Constructor & Destructor Documentation

◆ IlsMvServer()

Member Function Documentation

◆ AbortTransaction()

◆ acceptConnection()

◆ beginTransaction()

◆ CreateDefaultCompAtStartup()

◆ DeclObjectLabel()

◆ endTransaction()

◆ GetComponent()

◆ GetComponents()

◆ GetDefaultComp()

◆ GetDefaultUser()

◆ getInteractingUser()

◆ GetInteractingView()

◆ GetInteractor()

◆ GetLabelOfObject()

◆ GetObjectFromLabel()

◆ GetSingleton()

◆ Initialize()

◆ InterpretViewSpec()

◆ LoadResources()

◆ LoadViewSpec()

◆ Notify()

◆ onCloseView()

◆ onConnect()

◆ onDisconnect()

◆ onOpenView()

◆ OpenView() [1/2]

◆ OpenView() [2/2]

◆ processRequest()

◆ registerEndCycleTask()

◆ ReplyMessage()

◆ Run()

◆ SetCatchExceptionMode()

◆ SetTrace()

◆ SetTraceTime()

◆ UndeclObjectLabel() [1/2]

◆ UndeclObjectLabel() [2/2]

◆ UnsetCatchExceptionMode()