The DOFConnectionConfig class represents most of the information necessary for a DOF to create a connection. More...
Files | |
file | oal.h |
Header file for the C OAL functions, defines and data types. | |
Typedefs | |
typedef struct DOFConnectionConfig_t * | DOFConnectionConfig |
Immutable Connection configuration. | |
typedef struct DOFConnectionConfigBuilder_t * | DOFConnectionConfigBuilder |
Connection configuration builder. | |
Functions | |
DOFConnectionType | DOFConnectionConfig_GetConnectionType (const DOFConnectionConfig self) |
Get the type of Connection Type for the given DOFConnectionConfig. | |
DOFAddress | DOFConnectionConfig_GetAddress (const DOFConnectionConfig self) |
Get the target Address for the given DOFConnectionConfig. | |
DOFSecurityDesire | DOFConnectionConfig_GetSecurityDesire (const DOFConnectionConfig self) |
Get the SecurityDesire for the given DOFConnectionConfig. | |
DOFPermissionSet | DOFConnectionConfig_GetPermissions (const DOFConnectionConfig self) |
Get the Permissions for the given DOFConnectionConfig. | |
DTLConnectionConfig | DOFConnectionConfig_GetTransportConfig (const DOFConnectionConfig self) |
Get the transport-specific configuration for the DOFConnectionConfig. | |
DOFProtocolNegotiator | DOFConnectionConfig_GetProtocolNegotiator (const DOFConnectionConfig self) |
Get the current DOFProtocolNegotiator for the DOFConnectionConfig. | |
uint32 | DOFConnectionConfig_GetMaxSendSilence (const DOFConnectionConfig self) |
Get the current maximum send silence time in this DOFConnectionConfig. | |
uint32 | DOFConnectionConfig_GetMaxReceiveSilence (const DOFConnectionConfig self) |
Get the current maximum receive silence time in this DOFConnectionConfig. | |
DOFCredentials | DOFConnectionConfig_GetCredentials (const DOFConnectionConfig self) |
Get the credentials in this DOFConnectionConfig. | |
DOFCredentials | DOFConnectionConfig_GetDomainDiscoveryCredentials (const DOFConnectionConfig self) |
Gets the domain wildcard credentials set in the DOFConnectionConfig. | |
DOFOperationBridgeConfig | DOFConnectionConfig_GetBridge (DOFConnectionConfig const self) |
Gets the Operation Bridge set in the DOFConnectionConfig. | |
DOFOperationFilter | DOFConnectionConfig_GetReceiveFilter (DOFConnectionConfig const self) |
Gets the Receive Filter set in the DOFConnectionConfig. | |
DOFOperationFilter | DOFConnectionConfig_GetSendFilter (DOFConnectionConfig const self) |
Gets the Send Filter set in the DOFConnectionConfig. | |
DOFConnectionStreamRequestListener | DOFConnectionConfig_GetStreamRequestListener (const DOFConnectionConfig self) |
Gets the Stream Request Listner set in the DOFConnectionConfig. | |
boolean | DOFConnectionConfig_IsPermissionsExtendAllowed (DOFConnectionConfig const self) |
Checks to see if the Connection Config is set up to allow permission extensions. | |
void | DOFConnectionConfig_Destroy (DOFConnectionConfig self) |
Destroy a DOFConnectionConfig instance. | |
Builder | |
DOFConnectionConfigBuilder | DOFConnectionConfigBuilder_Create (DOFConnectionType type, DOFAddress target) |
Create a connection configuration builder, given the type and target address. | |
DOFConnectionConfigBuilder | DOFConnectionConfigBuilder_Create_Config (DOFConnectionConfig config) |
Create a connection configuration builder, given an existing connection configuration. | |
DOFConnectionConfigBuilder | DOFConnectionConfigBuilder_Create_State (DOFConnectionState state) |
Create a connection configuration builder, given an existing connection state. | |
DOFConnectionConfigBuilder | DOFConnectionConfigBuilder_Copy (DOFConnectionConfigBuilder self) |
Create a new copy of an existing DOFConnectionConfigBuilder. | |
boolean | DOFConnectionConfigBuilder_SetConnectionType (DOFConnectionConfigBuilder self, DOFConnectionType type) |
Set the Connection Type in the given DOFConnectionConfigBuilder. | |
boolean | DOFConnectionConfigBuilder_SetAddress (DOFConnectionConfigBuilder self, DOFAddress target) |
Set the target Address in the given DOFConnectionConfigBuilder. | |
boolean | DOFConnectionConfigBuilder_SetSecurityDesire (DOFConnectionConfigBuilder self, DOFSecurityDesire desire) |
Set the Security Desire in the given DOFConnectionConfigBuilder. | |
boolean | DOFConnectionConfigBuilder_SetCredentials (DOFConnectionConfigBuilder self, DOFCredentials credentials) |
Set the Credentials in the given DOFConnectionConfigBuilder. | |
boolean | DOFConnectionConfigBuilder_AddDomain (DOFConnectionConfigBuilder self, DOFDomainConfig domain) |
Add credentials to validate that the resulting connection is to an authorized AS (one able to process authentication requests) for a domain. | |
boolean | DOFConnectionConfigBuilder_SetDomainDiscoveryCredentials (DOFConnectionConfigBuilder self, DOFCredentials credentials) |
Sets the domain wildcard credentials for the connection. | |
boolean | DOFConnectionConfigBuilder_AddTrustedDomain (DOFConnectionConfigBuilder self, DOFObjectIDDomain domainID) |
Indicate that the resulting connection is a trusted route to an authorized AS (one able to process authentication requests) for a domain. | |
boolean | DOFConnectionConfigBuilder_SetPermissions (DOFConnectionConfigBuilder self, DOFPermissionSet perms) |
Set the Permissions in the given DOFConnectionConfigBuilder. | |
boolean | DOFConnectionConfigBuilder_SetPermissionsExtendAllowed (DOFConnectionConfigBuilder self, boolean extendAllowed) |
Set whether Permission extensions will be allowed or not. | |
boolean | DOFConnectionConfigBuilder_SetTransportConfig (DOFConnectionConfigBuilder self, DTLConnectionConfig config) |
Set the transport-specific configuration for the given DOFConnectionConfigBuilder Please refer to DOFConnectionConfigBuilder_Create for the default value for this setting. | |
boolean | DOFConnectionConfigBuilder_SetProtocolNegotiator (DOFConnectionConfigBuilder self, DOFProtocolNegotiator negotiator) |
Set the DOFProtocolNegotiator for the given DOFConnectionConfigBuilder. | |
boolean | DOFConnectionConfigBuilder_SetMaxSendSilence (DOFConnectionConfigBuilder self, uint32 maxSilence) |
Set the maximum time allowed to be silent before a packet must be sent for the given DOFConnectionConfigBuilder. | |
boolean | DOFConnectionConfigBuilder_SetMaxReceiveSilence (DOFConnectionConfigBuilder self, uint32 maxSilence) |
Set the maximum time allowed to be silent before a packet must be received for the given DOFConnectionConfigBuilder. | |
boolean | DOFConnectionConfigBuilder_SetBridge (DOFConnectionConfigBuilder self, DOFOperationBridgeConfig bridge) |
Set the Bridge in the DOFConnectionConfigBuilder. | |
boolean | DOFConnectionConfigBuilder_SetReceiveFilter (DOFConnectionConfigBuilder self, DOFOperationFilter filter) |
Set the Receive Filter in the DOFConnectionConfigBuilder. | |
boolean | DOFConnectionConfigBuilder_SetSendFilter (DOFConnectionConfigBuilder self, DOFOperationFilter filter) |
Set the Send Filter in the DOFConnectionConfigBuilder. | |
boolean | DOFConnectionConfigBuilder_SetStreamRequestListener (DOFConnectionConfigBuilder self, DOFConnectionStreamRequestListener streamListener) |
Set the Stream Request Listener in the DOFConnectionConfigBuilder. | |
void | DOFConnectionConfigBuilder_Destroy (DOFConnectionConfigBuilder self) |
Destroy a DOFConnectionConfigBuilder instance. | |
DOFConnectionConfig | DOFConnectionConfigBuilder_Build (DOFConnectionConfigBuilder self) |
Build an immutable DOFConnectionConfig from this DOFConnectionConfigBuilder instance. | |
DOFConnectionConfig | DOFConnectionConfigBuilder_BuildAndDestroy (DOFConnectionConfigBuilder self) |
Build an immutable DOFConnectionConfig from this DOFConnectionConfigBuilder instance, then destroy this DOFConnectionConfigBuilder instance. | |
The DOFConnectionConfig class represents most of the information necessary for a DOF to create a connection.