OpenDOF Project
Macros | Functions
DOSDPSSession
OpenDOF Stack (DOS)

Macros

#define DOS_REMOTE_NODE_CACHE_LEVEL_MAXIMUM
 DOS_REMOTE_NODE_CACHE_LEVEL_MAXIMUM Used to specify the amount of remote node security state that should be stored and used to validate packets that are received.
 
#define DOS_REMOTE_NODE_CACHE_LEVEL_MINIMUM
 DOS_REMOTE_NODE_CACHE_LEVEL_MINIMUM Used to specify that the least amount of remote node security state should be stored and used to validate packets that are received on a secure group.
 
#define DOS_REMOTE_NODE_CACHE_LEVEL_NORMAL
 DOS_REMOTE_NODE_CACHE_LEVEL_NORMAL Used to specify the normal amount of remote node security state should be stored and used to validate packets that are received on a secure group.
 
#define DOSDPSSESSION_SECURITY_DESIRE_ANY
 DOSDPSSESSION_SECURITY_DESIRE_ANY Used to set the security desire of a session to any.
 
#define DOSDPSSESSION_SECURITY_DESIRE_NOT_SECURE
 DOSDPSSESSION_SECURITY_DESIRE_NOT_SECURE Used to set the security desire of a session to not secure.
 
#define DOSDPSSESSION_SECURITY_DESIRE_SECURE
 DOSDPSSESSION_SECURITY_DESIRE_SECURE Used to se the security desire of a session to secure.
 
#define DOSDPSSESSION_SECURITY_DESIRE_SECURE_ANY
 DOSDPSSESSION_SECURITY_DESIRE_SECURE_ANY Used to set the security desire of a session to secure any.
 
#define DOSDPSSESSION_SECURITY_DESIRE_SECURE_AUTHENTICATE_ONLY
 DOSDPSSESSION_SECURITY_DESIRE_SECURE_AUTHENTICATE_ONLY Used to se the security desire of a session to authenticate only.
 
#define DOSDPSSESSION_TYPE_DATAGRAM
 DOSDPSSESSION_TYPE_DATAGRAM Used to set desired DPS session type to datagram.
 
#define DOSDPSSESSION_TYPE_GROUP_MEMBER_ONLY
 DOSDPSSESSION_TYPE_GROUP_MEMBER_ONLY Used to set desired DPS session type to secure group as a member only.
 

Functions

void DOSDPSSession_Close (void)
 Close the session set in DOSContext.
 
DOSObjectID DOSDPSSession_GetGroupID (DOSSession *session)
 Gets the groupid from a given session.
 
DOSTimeout DOSDPSSession_GetReceiveSilence (DOSSession *session)
 Returns the receive silence timeout of the given session.
 
uint8 DOSDPSSession_GetRemoteNodeSecurityStateCacheLevel (DOSSession *session)
 Gets the remote node security state cache level from a given session.
 
uint8 DOSDPSSession_GetSecurityDesire (DOSSession *session)
 Gets the security desire from a given session.
 
uint8 DOSDPSSession_GetSessionType (DOSDPSSession *session)
 Gets the type of session from a given session.
 
DOSStatus DOSDPSSession_Initialize (DOSDPSSession *session, uint8 sessionType)
 Set The session type to sessionType and set all other session configuration to the defaults.
 
boolean DOSDPSSession_IsOpen (DOSDPSSession *session)
 Checks if the session is open.
 
DOSStatus DOSDPSSession_Open (void)
 Open an DPS session with a remote node using using the configuration in DOSContext.
 
void DOSDPSSession_SetGroupID (DOSDPSSession *session, DOSObjectID groupid)
 Sets the group id of the secure group this session will try to join.
 
void DOSDPSSession_SetPermissions (DOSDPSSession *session, DOSPermissionSet *permissions)
 Sets the permission set for a session.
 
void DOSDPSSession_SetReceiveSilence (DOSDPSSession *session, DOSTimeout timeout)
 Set the the amount of time in tenths of a second before the session is closed if nothing is received by the session.
 
void DOSDPSSession_SetRemoteNodeSecurityStateCacheLevel (DOSDPSSession *session, uint8 level)
 Set the cache level for the internal security state related to remote nodes.
 
void DOSDPSSession_SetSecurityDesire (DOSDPSSession *session, uint8 securityDesire)
 Sets the security desire of a session.
 
void DOSDPSSession_SetTimeout (DOSDPSSession *session, DOSTimeout timeout)
 Sets the amount of time that should be taken to establish the session.
 

Detailed Description

core-c-cos Version 7.0.1 Build 0
2018-02-08