MAK Legion API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Typedefs | Functions
c_connection.h File Reference

Go to the source code of this file.

Typedefs

typedef unsigned long long ConnectionHandle
 

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, UInt32 *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)
 
LEGIONNETRUNTIME_DLL LEG_ReturnCode legion_connection_removeInterest (ConnectionHandle connHandle)
 
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_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)
 

Typedef Documentation

typedef unsigned long long ConnectionHandle

ConnectionHandle

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]connHandleThe connection handle
[in]attrSetTypeThe 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,
UInt32 *  clientId 
)

Get client ID of this client-server connection

Parameters
[in]connHandleThe connection handle
[out]clientIdReturn 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]connHandleThe connection handle
[out]typeReturn boundary type of intend
[out]boundaryReturn 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]connHandleThe connection handle
[out]typeReturn boundary type of interest
[out]boundaryReturn boundary of interest
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]connHandleThe connection handle
[out]connectedReturn 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]connHandleThe connection handle
[in]attrSetTypeThe 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]connHandleThe 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]connHandleThe 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]connHandleThe connection handle
[in]attrSetTypeThe 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]connHandleThe connection handle
[in]boundarySet 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 
)

Set client's interest boundary

Parameters
[in]connHandleThe connection handle
[in]boundarySet client's interest boundary using input boundary
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]connHandleThe connection handle
[in]maxProcessingTimemax 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]connHandleThe 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]connHandleThe 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]configHanfleThe configuration handle
[in]dbHandleThe database handle
[out]connHandleThe 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]connHandleThe 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]connHandleThe connection handle
[out]ownershipMgrHandleThe hanle of ownership manager
Returns
LEG_ReturnCode 0 indicates success, non 0 error code indicates failure
Document ID: Generated on Mon Mar 8 15:11:30 EST 2021 from SVN revision 225633
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)