sopc_service_call_context.h File Reference

Defines abstract context type that can be use to obtain context associated to a service call (write, callmethod, etc.) More...

#include "sopc_address_space_access.h"
#include "sopc_enum_types.h"
#include "sopc_user.h"

Go to the source code of this file.

Typedefs
typedef struct SOPC_CallContext	SOPC_CallContext
	Context provided when a service callback is called (write notification, method call). The context can only be used during the callback call, see getters available.

Functions
const SOPC_User *	SOPC_CallContext_GetUser (const SOPC_CallContext *callContextPtr)
	Returns the user that called the service.
OpcUa_MessageSecurityMode	SOPC_CallContext_GetSecurityMode (const SOPC_CallContext *callContextPtr)
	Returns the security mode of the connection used to call the service.
const char *	SOPC_CallContext_GetSecurityPolicy (const SOPC_CallContext *callContextPtr)
	Returns the security policy of the connection used to call the service.
uint32_t	SOPC_CallContext_GetEndpointConfigIdx (const SOPC_CallContext *callContextPtr)
	Returns the server endpoint of the connection used to call the service.
SOPC_AddressSpaceAccess *	SOPC_CallContext_GetAddressSpaceAccess (const SOPC_CallContext *callContextPtr)
	Get direct access to the address space. AddressSpace is only available during a method call and shall not be kept nor used after method call ends. Otherwise behavior is undefined.

Detailed Description

Defines abstract context type that can be use to obtain context associated to a service call (write, callmethod, etc.)

Typedef Documentation

SOPC_CallContext

typedef struct SOPC_CallContext SOPC_CallContext

Context provided when a service callback is called (write notification, method call). The context can only be used during the callback call, see getters available.

Function Documentation

SOPC_CallContext_GetUser()

const SOPC_User * SOPC_CallContext_GetUser

(

const SOPC_CallContext *

callContextPtr

)

Returns the user that called the service.

SOPC_CallContext_GetSecurityMode()

OpcUa_MessageSecurityMode SOPC_CallContext_GetSecurityMode

(

const SOPC_CallContext *

callContextPtr

)

Returns the security mode of the connection used to call the service.

SOPC_CallContext_GetSecurityPolicy()

const char * SOPC_CallContext_GetSecurityPolicy

(

const SOPC_CallContext *

callContextPtr

)

Returns the security policy of the connection used to call the service.

SOPC_CallContext_GetEndpointConfigIdx()

uint32_t SOPC_CallContext_GetEndpointConfigIdx

(

const SOPC_CallContext *

callContextPtr

)

Returns the server endpoint of the connection used to call the service.

SOPC_CallContext_GetAddressSpaceAccess()

SOPC_AddressSpaceAccess * SOPC_CallContext_GetAddressSpaceAccess

(

const SOPC_CallContext *

callContextPtr

)

Get direct access to the address space. AddressSpace is only available during a method call and shall not be kept nor used after method call ends. Otherwise behavior is undefined.