c_connection.h File Reference

Go to the source code of this file.

Functions
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_net_createConnection (ConfigHandle configHandle, DatabaseHandle dbHandle, ConnectionHandle *connHandle)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_net_destroyConnection (ConnectionHandle connHandle)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_net_owershipManager (ConnectionHandle connHandle, OwnershipManagerHandle *ownershipMgrHandle)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_connection_isConnected (ConnectionHandle connHandle, Bool *connected)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_connection_startProcessingMessages (ConnectionHandle connHandle, double maxProcessingTime=0.0)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_connection_stopProcessingMessages (ConnectionHandle connHandle)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_connection_waitUntilDonProcessingMessages (ConnectionHandle connHandle)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_connection_clientId (ConnectionHandle connHandle, ClientId *clientId)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_connection_interest (ConnectionHandle connHandle, LEG_BoundaryType *type, LEG_Boundary *boundary=0)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_connection_setInterest (ConnectionHandle connHandle, LEG_Boundary *boundary, LEG_InterestGranularity granularity)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_connection_removeInterest (ConnectionHandle connHandle)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_connection_interestGranularity (ConnectionHandle connHandle, LEG_InterestGranularity *granularity)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_connection_intent (ConnectionHandle connHandle, LEG_BoundaryType *type, LEG_Boundary *boundary=0)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_connection_setIntent (ConnectionHandle connHandle, LEG_Boundary *boundary)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_connection_removeIntent (ConnectionHandle connHandle)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_connection_isAbsoluteTimestamp (ConnectionHandle connHandle, LEG_Bool *isAbsoluteTimestamp=0)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_connection_setIsAbsoluteTimestamp (ConnectionHandle connHandle, LEG_Bool absoluteTimeFlag)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_connection_setAttributeSetInterest (ConnectionHandle connHandle, const UInt32 attrSetType=0xffff)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_connection_addAttributeSetInterest (ConnectionHandle connHandle, const UInt32 attrSetType=0xffff)
LEGIONNETRUNTIME_DLL LEG_ReturnCode	legion_connection_removeAttributeSetInterest (ConnectionHandle connHandle, const UInt32 attrSetType=0xffff)

Function Documentation

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_addAttributeSetInterest	(	ConnectionHandle	connHandle,
		const UInt32	attrSetType = 0xffff
	)

Add/Set/Remove interest of a single attributeSet or all attributeSets

Parameters

[in]	connHandle	The connection handle
[in]	attrSetType	The attributeSet identifier of interest, interest applies to all attribute sets by default.

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_clientId	(	ConnectionHandle	connHandle,
		ClientId *	clientId
	)

Get client ID of this client-server connection

Parameters

[in]	connHandle	The connection handle
[out]	clientId	Return the client id associated with this connection

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_intent	(	ConnectionHandle	connHandle,
		LEG_BoundaryType *	type,
		LEG_Boundary *	boundary = 0
	)

Get client's intent boundary info of this connection

Parameters

[in]	connHandle	The connection handle
[out]	type	Return boundary type of intend
[out]	boundary	Return boundary of intent

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_interest	(	ConnectionHandle	connHandle,
		LEG_BoundaryType *	type,
		LEG_Boundary *	boundary = 0
	)

Get client's interest boundary of this connection

Parameters

[in]	connHandle	The connection handle
[out]	type	Return boundary type of interest
[out]	boundary	Return boundary of interest

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_interestGranularity	(	ConnectionHandle	connHandle,
		LEG_InterestGranularity *	granularity
	)

Get the connections filter type

Parameters

[in]	connHandle	The connection handle
[out]	granularity	Return interest filter type (fine or coarse grain)

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_isAbsoluteTimestamp	(	ConnectionHandle	connHandle,
		LEG_Bool *	isAbsoluteTimestamp = 0
	)

Check if connection's timestamp is absolute time

Parameters

[in]	connHandle	The connection handle
[out]	isAbsoluteTimestamp	Output value is true if absolute timestamp is used by this client connection

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_isConnected	(	ConnectionHandle	connHandle,
		Bool *	connected
	)

Check if the connection is ok

Parameters

[in]	connHandle	The connection handle
[out]	connected	Return true if it's ok, otherwise false

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_removeAttributeSetInterest	(	ConnectionHandle	connHandle,
		const UInt32	attrSetType = 0xffff
	)

Add/Set/Remove interest of a single attributeSet or all attributeSets

Parameters

[in]	connHandle	The connection handle
[in]	attrSetType	The attributeSet identifier of interest, interest applies to all attribute sets by default.

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_removeIntent

(

ConnectionHandle

connHandle

)

Remove client's intent boundary

Parameters

[in]

connHandle

The connection handle

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_removeInterest

(

ConnectionHandle

connHandle

)

Remove client's interest boundary

Parameters

[in]

connHandle

The connection handle

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_setAttributeSetInterest	(	ConnectionHandle	connHandle,
		const UInt32	attrSetType = 0xffff
	)

Add/Set/Remove interest of a single attributeSet or all attributeSets

Parameters

[in]	connHandle	The connection handle
[in]	attrSetType	The attributeSet identifier of interest, interest applies to all attribute sets by default.

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_setIntent	(	ConnectionHandle	connHandle,
		LEG_Boundary *	boundary
	)

Set client's intent boundary

Parameters

[in]	connHandle	The connection handle
[in]	boundary	Set client's intent boundary using input boundary

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_setInterest	(	ConnectionHandle	connHandle,
		LEG_Boundary *	boundary,
		LEG_InterestGranularity	granularity
	)

Set client's interest boundary

Parameters

[in]	connHandle	The connection handle
[in]	boundary	Set client's interest boundary using input boundary
	int]	granularity Indicate whether to use boundary as fine grain or coarse grain filter

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_setIsAbsoluteTimestamp	(	ConnectionHandle	connHandle,
		LEG_Bool	absoluteTimeFlag
	)

Set absolute timestamp flag for this connection

Parameters

[in]	connHandle	The connection handle
[in]	absoluteTimeFlag	Flag indicating the timestamp is absolute time.

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_startProcessingMessages	(	ConnectionHandle	connHandle,
		double	maxProcessingTime = 0.0
	)

Start processing messages for this connection

Parameters

[in]	connHandle	The connection handle
[in]	maxProcessingTime	max processing time in seconds, process messages until it's done by default

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_stopProcessingMessages

(

ConnectionHandle

connHandle

)

Stop processing messages for this connection

Parameters

[in]

connHandle

The connection handle

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_waitUntilDonProcessingMessages

(

ConnectionHandle

connHandle

)

Wait until done of processing messages for this connection

Parameters

[in]

connHandle

The connection handle

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_net_createConnection	(	ConfigHandle	configHandle,
		DatabaseHandle	dbHandle,
		ConnectionHandle *	connHandle
	)

Create a client-server connection

Parameters

[in]	configHanfle	The configuration handle
[in]	dbHandle	The database handle
[out]	connHandle	The created connection handle

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_net_destroyConnection

(

ConnectionHandle

connHandle

)

Delete a connection

Parameters

[in]

connHandle

The connection handle to delete

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure

LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_net_owershipManager	(	ConnectionHandle	connHandle,
		OwnershipManagerHandle *	ownershipMgrHandle
	)

Get ownership manager handle

Parameters

[in]	connHandle	The connection handle
[out]	ownershipMgrHandle	The hanle of ownership manager

Returns

LEG_ReturnCode 0 indicates success, non 0 error code indicates failure