Mms_client_api_group

Data Structures
struct	ItuObjectIdentifier
	ITU (International Telecommunication Union) object identifier (OID) More...
struct	IsoApplicationReference
	ISO application reference (specifies an ISO application endpoint) More...
struct	AcseAuthenticationParameter
struct	TSelector
	COTP T selector. More...
struct	SSelector
struct	PSelector
struct	IsoApplicationAddress

Typedefs
typedef AcseServiceUserDiagnostics(*	AcseAuthenticator) (void *parameter, AcseAuthenticationParameter authParameter, void **securityToken, IsoApplicationAddress localAppAddr, IsoApplicationAddress remoteAppAddr, Socket socket)
	Callback function to authenticate a peer.
typedef ASecurityConfiguration(*	AcseALSConfigurationProvider) (void *parameter, IsoApplicationAddress localAppRef, IsoApplicationAddress remoteAppRef, Socket socket)

Enumerations
enum	AcseAuthenticationMechanism {   ACSE_AUTH_NONE = 0 , ACSE_AUTH_PASSWORD = 1 , ACSE_AUTH_CERTIFICATE = 2 , ACSE_AUTH_TLS = 3 ,   ACSE_AUTH_MECH_UNKNOWN = 99 }
	authentication mechanism used by AcseAuthenticator More...
enum	AcseServiceUserDiagnostics {   ACSE_USER_OK = 0 , ACSE_USER_NO_REASON_GIVEN = 1 , ACSE_USER_APP_CONTEXT_NAME_NOT_SUPPORTED = 2 , ACSE_USER_CALLING_AP_TITLE_NOT_RECOGNIZED = 3 ,   ACSE_USER_CALLING_AP_INVOCATION_ID_NOT_RECOGNIZED = 4 , ACSE_USER_CALLING_AE_QUALIFIER_NOT_RECOGNIZED = 5 , ACSE_USER_CALLING_AE_INVOCATION_ID_NOT_RECOGNIZED = 6 , ACSE_USER_CALLED_AP_TITLE_NOT_RECOGNIZED = 7 ,   ACSE_USER_CALLED_AP_INVOCATION_ID_NOT_RECOGNIZED = 8 , ACSE_USER_CALLED_AE_QUALIFIER_NOT_RECOGNIZED = 9 , ACSE_USER_CALLED_AE_INVOCATION_ID_NOT_RECOGNIZED = 10 , ACSE_USER_AUTH_MECH_NAME_NOT_RECOGNIZED = 11 ,   ACSE_USER_AUTH_MECH_NAME_REQUIRED = 12 , ACSE_USER_AUTH_FAILURE = 13 , ACSE_USER_AUTH_REQUIRED = 14 }
	Diagnostic information for ACSE service user (authentication) result. More...

Functions
LIBMMS_API void	ItuObjectIdentifier_setFromString (ItuObjectIdentifier *self, const char *str)
LIBMMS_API char *	ItuObjectIdentifier_toString (ItuObjectIdentifier *self)
	Convert OID to string.
const char *	AcseServiceUserDiagnostics_toString (AcseServiceUserDiagnostics diag)
AcseAuthenticationParameter	AcseAuthenticationParameter_create (void)
void	AcseAuthenticationParameter_destroy (AcseAuthenticationParameter self)
void	AcseAuthenticationParameter_setAuthMechanism (AcseAuthenticationParameter self, AcseAuthenticationMechanism mechanism)
void	AcseAuthenticationParameter_setPassword (AcseAuthenticationParameter self, char *password)
LIBMMS_API void	IsoApplicationAddress_setApTitle (IsoApplicationAddress self, const char *apTitle)
	set the AP-Title
LIBMMS_API void	IsoApplicationAddress_setAeQualifier (IsoApplicationAddress self, int aeQualifier)
	set the AE-Qualifier
LIBMMS_API void	IsoApplicationAddress_setAeInvocationId (IsoApplicationAddress self, int aeInvocationId)
	set the AE-invocation-identifier
LIBMMS_API void	IsoApplicationAddress_setApInvocationId (IsoApplicationAddress self, int apInvocationId)
	set the AP-invocation-identifier
LIBMMS_API void	IsoApplicationAddress_setLowerLayerAddresses (IsoApplicationAddress self, PSelector pSelector, SSelector sSelector, TSelector tSelector)
	set addresses for the lower layers

Detailed Description

Typedef Documentation

AcseALSConfigurationProvider

typedef ASecurityConfiguration(* AcseALSConfigurationProvider) (void *parameter, IsoApplicationAddress localAppRef, IsoApplicationAddress remoteAppRef, Socket socket)

AcseAuthenticator

typedef AcseServiceUserDiagnostics(* AcseAuthenticator) (void *parameter, AcseAuthenticationParameter authParameter, void **securityToken, IsoApplicationAddress localAppAddr, IsoApplicationAddress remoteAppAddr, Socket socket)

Callback function to authenticate a peer.

Parameters

parameter	user provided parameter - set when user registers the authenticator
authParameter	the authentication parameters provided by the client
securityToken	pointer where to store an application specific security token - can be ignored if not used.
remoteAppAddr	ISO application address of the peer (ap-title + ae-qualifier, ...)

Returns

ACSE_USER_OK if client connection is accepted, error code otherwise

Enumeration Type Documentation

AcseAuthenticationMechanism

enum AcseAuthenticationMechanism

authentication mechanism used by AcseAuthenticator

Enumerator
ACSE_AUTH_NONE	Neither ACSE nor TLS authentication used
ACSE_AUTH_PASSWORD	Use ACSE password for peer authentication
ACSE_AUTH_CERTIFICATE	Use ACSE certificate for peer authentication
ACSE_AUTH_TLS	Use TLS certificate for peer authentication
ACSE_AUTH_MECH_UNKNOWN	Unknown mechanism for peer authentication

AcseServiceUserDiagnostics

enum AcseServiceUserDiagnostics

Diagnostic information for ACSE service user (authentication) result.

Enumerator
ACSE_USER_OK
ACSE_USER_NO_REASON_GIVEN
ACSE_USER_APP_CONTEXT_NAME_NOT_SUPPORTED
ACSE_USER_CALLING_AP_TITLE_NOT_RECOGNIZED
ACSE_USER_CALLING_AP_INVOCATION_ID_NOT_RECOGNIZED
ACSE_USER_CALLING_AE_QUALIFIER_NOT_RECOGNIZED
ACSE_USER_CALLING_AE_INVOCATION_ID_NOT_RECOGNIZED
ACSE_USER_CALLED_AP_TITLE_NOT_RECOGNIZED
ACSE_USER_CALLED_AP_INVOCATION_ID_NOT_RECOGNIZED
ACSE_USER_CALLED_AE_QUALIFIER_NOT_RECOGNIZED
ACSE_USER_CALLED_AE_INVOCATION_ID_NOT_RECOGNIZED
ACSE_USER_AUTH_MECH_NAME_NOT_RECOGNIZED
ACSE_USER_AUTH_MECH_NAME_REQUIRED
ACSE_USER_AUTH_FAILURE
ACSE_USER_AUTH_REQUIRED

Function Documentation

AcseAuthenticationParameter_create()

AcseAuthenticationParameter AcseAuthenticationParameter_create

(

void

)

AcseAuthenticationParameter_destroy()

void AcseAuthenticationParameter_destroy

(

AcseAuthenticationParameter

self

)

AcseAuthenticationParameter_setAuthMechanism()

void AcseAuthenticationParameter_setAuthMechanism	(	AcseAuthenticationParameter	self,
		AcseAuthenticationMechanism	mechanism )

AcseAuthenticationParameter_setPassword()

void AcseAuthenticationParameter_setPassword	(	AcseAuthenticationParameter	self,
		char *	password )

AcseServiceUserDiagnostics_toString()

const char * AcseServiceUserDiagnostics_toString

(

AcseServiceUserDiagnostics

diag

)

IsoApplicationAddress_setAeInvocationId()

LIBMMS_API void IsoApplicationAddress_setAeInvocationId	(	IsoApplicationAddress	self,
		int	aeInvocationId )

set the AE-invocation-identifier

Parameters

aeInvocationId

the AE-invocation-identifier

IsoApplicationAddress_setAeQualifier()

LIBMMS_API void IsoApplicationAddress_setAeQualifier	(	IsoApplicationAddress	self,
		int	aeQualifier )

set the AE-Qualifier

Parameters

aeQualifier

the AP-qualifier

IsoApplicationAddress_setApInvocationId()

LIBMMS_API void IsoApplicationAddress_setApInvocationId	(	IsoApplicationAddress	self,
		int	apInvocationId )

set the AP-invocation-identifier

Parameters

aeInvocationId

the AP-invocation-identifier

IsoApplicationAddress_setApTitle()

LIBMMS_API void IsoApplicationAddress_setApTitle	(	IsoApplicationAddress	self,
		const char *	apTitle )

set the AP-Title

If apTitle is NULL the parameter the AP-Title and AE-Qualifier will not be transmitted. This seems to be required by some server devices.

Parameters

self	the IsoConnectionParameters instance
apTitle	the AP-Title OID as string.

IsoApplicationAddress_setLowerLayerAddresses()

LIBMMS_API void IsoApplicationAddress_setLowerLayerAddresses	(	IsoApplicationAddress	self,
		PSelector	pSelector,
		SSelector	sSelector,
		TSelector	tSelector )

set addresses for the lower layers

This function can be used to set the addresses for the lower layer protocols (presentation, session, and transport layer). Calling this function is optional and not recommended. If not called the default parameters are used.

Parameters

self	the IsoConnectionParameters instance
pSelector	the P-Selector (presentation layer address)
sSelector	the S-Selector (session layer address)
tSelector	the T-Selector (ISO transport layer address)

ItuObjectIdentifier_setFromString()

LIBMMS_API void ItuObjectIdentifier_setFromString	(	ItuObjectIdentifier *	self,
		const char *	str )

ItuObjectIdentifier_toString()

LIBMMS_API char * ItuObjectIdentifier_toString

(

ItuObjectIdentifier *

self

)

Convert OID to string.

Returns

the OID as dot separated string (has to be free'd by the caller)