#include "legato.h"
#include "taf_someipDef_server.h"
#include "taf_someipClnt_common.h"

Functions
le_msg_ServiceRef_t	taf_someipClnt_GetServiceRef (void)

le_msg_SessionRef_t	taf_someipClnt_GetClientSessionRef (void)

void	taf_someipClnt_AdvertiseService (void)

uint16_t	taf_someipClnt_GetClientId (void)

le_result_t	taf_someipClnt_GetClientIdEx (const char LE_NONNULL ifName, uint16_t clientIdPtr)

taf_someipClnt_ServiceRef_t	taf_someipClnt_RequestService (uint16_t serviceId, uint16_t instanceId)

taf_someipClnt_ServiceRef_t	taf_someipClnt_RequestServiceEx (uint16_t serviceId, uint16_t instanceId, const char *LE_NONNULL ifName)

le_result_t	taf_someipClnt_ReleaseService (taf_someipClnt_ServiceRef_t serviceRef)

le_result_t	taf_someipClnt_GetState (taf_someipClnt_ServiceRef_t serviceRef, taf_someipClnt_State_t *statePtr)

le_result_t	taf_someipClnt_GetVersion (taf_someipClnt_ServiceRef_t serviceRef, uint8_t majVerPtr, uint32_t minVerPtr)

taf_someipClnt_StateChangeHandlerRef_t	taf_someipClnt_AddStateChangeHandler (taf_someipClnt_ServiceRef_t serviceRef, taf_someipClnt_StateChangeHandlerFunc_t handlerPtr, void *contextPtr)

void	taf_someipClnt_RemoveStateChangeHandler (taf_someipClnt_StateChangeHandlerRef_t handlerRef)

taf_someipClnt_TxMsgRef_t	taf_someipClnt_CreateMsg (taf_someipClnt_ServiceRef_t serviceRef, uint16_t methodId)

le_result_t	taf_someipClnt_SetNonRet (taf_someipClnt_TxMsgRef_t msgRef)

le_result_t	taf_someipClnt_SetReliable (taf_someipClnt_TxMsgRef_t msgRef)

le_result_t	taf_someipClnt_SetTimeout (taf_someipClnt_TxMsgRef_t msgRef, uint32_t timeOut)

le_result_t	taf_someipClnt_SetPayload (taf_someipClnt_TxMsgRef_t msgRef, const uint8_t *dataPtr, size_t dataSize)

le_result_t	taf_someipClnt_DeleteMsg (taf_someipClnt_TxMsgRef_t msgRef)

void	taf_someipClnt_RequestResponse (taf_someipClnt_TxMsgRef_t msgRef, taf_someipClnt_RespMsgHandlerFunc_t handlerPtr, void *contextPtr)

le_result_t	taf_someipClnt_EnableEventGroup (taf_someipClnt_ServiceRef_t serviceRef, uint16_t eventGroupId, uint16_t eventId, taf_someipDef_EventType_t eventType)

le_result_t	taf_someipClnt_DisableEventGroup (taf_someipClnt_ServiceRef_t serviceRef, uint16_t eventGroupId)

le_result_t	taf_someipClnt_SubscribeEventGroup (taf_someipClnt_ServiceRef_t serviceRef, uint16_t eventGroupId)

le_result_t	taf_someipClnt_UnsubscribeEventGroup (taf_someipClnt_ServiceRef_t serviceRef, uint16_t eventGroupId)

taf_someipClnt_EventMsgHandlerRef_t	taf_someipClnt_AddEventMsgHandler (taf_someipClnt_ServiceRef_t serviceRef, uint16_t eventGroupId, taf_someipClnt_EventMsgHandlerFunc_t handlerPtr, void *contextPtr)

void	taf_someipClnt_RemoveEventMsgHandler (taf_someipClnt_EventMsgHandlerRef_t handlerRef)

Function Documentation

◆ taf_someipClnt_GetServiceRef()

le_msg_ServiceRef_t taf_someipClnt_GetServiceRef ( void )

Get the server service reference

◆ taf_someipClnt_GetClientSessionRef()

le_msg_SessionRef_t taf_someipClnt_GetClientSessionRef ( void )

Get the client session reference for the current message

◆ taf_someipClnt_AdvertiseService()

void taf_someipClnt_AdvertiseService ( void )

Initialize the server and advertise the service.

◆ taf_someipClnt_GetClientId()

uint16_t taf_someipClnt_GetClientId ( void )

Reference to a SOME/IP client-service-instance. Reference to a SOME/IP request message. Service state. Handler for the service state change. Reference type used by Add/Remove functions for EVENT 'taf_someipClnt_StateChange' The asynchronous response handler for RequestResponse(). If "result" is not LE_OK, other input parameters can be ignored.

Returns

LE_OK – Succeeded.
LE_BAD_PARAMETER – Invalid input parameters for RequestResponse().
LE_NOT_PERMITTED – The message is not created by the client.
LE_UNAVAILABLE – Service is not available.
LE_TIMEOUT – Response time outs. Handler for an event message. Reference type used by Add/Remove functions for EVENT 'taf_someipClnt_EventMsg' Gets the SOME/IP client ID of client-service-instance on default network interface.

Client ID.

Gets the SOME/IP client ID of client-service-instance on default network interface.

Returns

Client ID.

◆ taf_someipClnt_GetClientIdEx()

le_result_t taf_someipClnt_GetClientIdEx	(	const char *LE_NONNULL	ifName,
		uint16_t *	clientIdPtr
	)

Gets the SOME/IP client ID of client-service-instance on a dedicated network interface. The ifName shall match the device name specified in one of the JSON files.

Returns

LE_OK – Succeeded.
LE_BAD_PARAMETER – Invalid parameters.
LE_NOT_FOUND – Client ID is not found.

Parameters

[in]	ifName	Network interface name.
[out]	clientIdPtr	SOME/IP Client ID.

◆ taf_someipClnt_RequestService()

taf_someipClnt_ServiceRef_t taf_someipClnt_RequestService	(	uint16_t	serviceId,
		uint16_t	instanceId
	)

Requests a client-service-instance on default network interface and returns the reference to the client-service-instance.

Returns

Reference to the client-service-instance.
NULL if invalid parameters.

Parameters

[in]	serviceId	Service ID.
[in]	instanceId	Instance ID.

◆ taf_someipClnt_RequestServiceEx()

taf_someipClnt_ServiceRef_t taf_someipClnt_RequestServiceEx	(	uint16_t	serviceId,
		uint16_t	instanceId,
		const char *LE_NONNULL	ifName
	)

Requests a client-service-instance on a dedicated network interface and returns the reference to the client-service-instance. The ifName shall match the device name specified in one of the JSON files.

Returns

Reference to the client-service-instance.
NULL if invalid parameters.

Parameters

[in]	serviceId	Service ID.
[in]	instanceId	Instance ID.
[in]	ifName	Network interface name.

◆ taf_someipClnt_ReleaseService()

le_result_t taf_someipClnt_ReleaseService ( taf_someipClnt_ServiceRef_t serviceRef )

Releases a client-service-instance.

Returns

LE_OK – Succeeded.
LE_BAD_PARAMETER – Invalid parameters.
LE_NOT_PERMITTED – The service is not requested by the client.
LE_BUSY – The service still has active handlers or pending requests.

Parameters

[in] serviceRef Service Reference.

◆ taf_someipClnt_GetState()

le_result_t taf_someipClnt_GetState	(	taf_someipClnt_ServiceRef_t	serviceRef,
		taf_someipClnt_State_t *	statePtr
	)

Gets the service state.

Returns

LE_OK – Succeeded.
LE_BAD_PARAMETER – Invalid parameters.
LE_NOT_PERMITTED – The service is not requested by the client.

Parameters

[in]	serviceRef	Service Reference.
[out]	statePtr	Service State.

◆ taf_someipClnt_GetVersion()

le_result_t taf_someipClnt_GetVersion	(	taf_someipClnt_ServiceRef_t	serviceRef,
		uint8_t *	majVerPtr,
		uint32_t *	minVerPtr
	)

Gets the service version.

Returns

LE_OK – Succeeded.
LE_BAD_PARAMETER – Invalid parameters.
LE_NOT_PERMITTED – The service is not requested by the client.
LE_UNAVAILABLE – Service is unavailable.

Parameters

[in]	serviceRef	Service Reference.
[out]	majVerPtr	Major Version.
[out]	minVerPtr	Minor Version.

◆ taf_someipClnt_AddStateChangeHandler()

taf_someipClnt_StateChangeHandlerRef_t taf_someipClnt_AddStateChangeHandler	(	taf_someipClnt_ServiceRef_t	serviceRef,
		taf_someipClnt_StateChangeHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_someipClnt_StateChange'

This event provides information on the service state change.

Parameters

[in]	serviceRef	Service Reference.
[in]	handlerPtr
[in]	contextPtr

◆ taf_someipClnt_RemoveStateChangeHandler()

void taf_someipClnt_RemoveStateChangeHandler ( taf_someipClnt_StateChangeHandlerRef_t handlerRef )

Remove handler function for EVENT 'taf_someipClnt_StateChange'

Parameters

[in] handlerRef

◆ taf_someipClnt_CreateMsg()

taf_someipClnt_TxMsgRef_t taf_someipClnt_CreateMsg	(	taf_someipClnt_ServiceRef_t	serviceRef,
		uint16_t	methodId
	)

Creates a request message and sets the destination.

Returns

Reference to the request message.
NULL if invalid parameters.

Parameters

[in]	serviceRef	Service Reference.
[in]	methodId	Method ID.

◆ taf_someipClnt_SetNonRet()

le_result_t taf_someipClnt_SetNonRet ( taf_someipClnt_TxMsgRef_t msgRef )

Sets the request to a non-return-request(MT_REQUEST_NO_RETURN). By default, it is MT_REQUEST.

Returns

LE_OK – Succeeded.
LE_BAD_PARAMETER – Invalid input parameters.
LE_NOT_PERMITTED – The message is not created by the client.

Parameters

[in] msgRef Tx message reference.

◆ taf_someipClnt_SetReliable()

le_result_t taf_someipClnt_SetReliable ( taf_someipClnt_TxMsgRef_t msgRef )

Uses TCP to send the request. By default, it uses UDP.

Returns

LE_OK – Succeeded.
LE_BAD_PARAMETER – Invalid input parameters.
LE_NOT_PERMITTED – The message is not created by the client.

Parameters

[in] msgRef Tx message reference.

◆ taf_someipClnt_SetTimeout()

le_result_t taf_someipClnt_SetTimeout	(	taf_someipClnt_TxMsgRef_t	msgRef,
		uint32_t	timeOut
	)

Sets the timeout in milliseconds for waiting for the response. By default, the timeout is 30000 ms. 0 means NEVER time out.

Returns

LE_OK – Succeeded.
LE_BAD_PARAMETER – Invalid input parameters.
LE_NOT_PERMITTED – The message is not created by the client.

Parameters

[in]	msgRef	Tx message reference.
[in]	timeOut	Timeout in milliseconds.

◆ taf_someipClnt_SetPayload()

le_result_t taf_someipClnt_SetPayload	(	taf_someipClnt_TxMsgRef_t	msgRef,
		const uint8_t *	dataPtr,
		size_t	dataSize
	)

Sets the payload data of the request. By default, the payload is empty.

Returns

LE_OK – Succeeded.
LE_BAD_PARAMETER – Invalid input parameters.
LE_NOT_PERMITTED – The message is not created by the client.

Parameters

[in]	msgRef	Tx message reference.
[in]	dataPtr	Payload data.
[in]	dataSize

◆ taf_someipClnt_DeleteMsg()

le_result_t taf_someipClnt_DeleteMsg ( taf_someipClnt_TxMsgRef_t msgRef )

Deletes a request message.

Returns

LE_OK – Succeeded.
LE_BAD_PARAMETER – Invalid input parameters.
LE_NOT_PERMITTED – The message is not created by the client.

Parameters

[in] msgRef Tx message reference.

◆ taf_someipClnt_RequestResponse()

void taf_someipClnt_RequestResponse	(	taf_someipClnt_TxMsgRef_t	msgRef,
		taf_someipClnt_RespMsgHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Sends an asynchronous request message. The response handler will be called once the response is received or any errors occur.

NOTE: The request message will be automatically deleted after calling this API.

Parameters

[in]	msgRef	Tx message reference.
[in]	handlerPtr	Response message handler.
[in]	contextPtr

◆ taf_someipClnt_EnableEventGroup()

le_result_t taf_someipClnt_EnableEventGroup	(	taf_someipClnt_ServiceRef_t	serviceRef,
		uint16_t	eventGroupId,
		uint16_t	eventId,
		taf_someipDef_EventType_t	eventType
	)

Enables an event group by adding an event into the group.

NOTE: This API can be called multiple times if there is more than one event to be added into the group. Currently, one event can only be added into one group, and one event group can be enabled only by one client.

Returns

LE_OK – Succeeded.
LE_BAD_PARAMETER – Invalid input parameters.
LE_NOT_PERMITTED – The service is not requested by the client, or the event group is subscribed or enabled by another client, or the event is already added into another group.
LE_DUPLICATE – The event is already in this group.

Parameters

[in]	serviceRef	Service Reference.
[in]	eventGroupId	Event Group ID.
[in]	eventId	Event ID.
[in]	eventType	Event Type.

◆ taf_someipClnt_DisableEventGroup()

le_result_t taf_someipClnt_DisableEventGroup	(	taf_someipClnt_ServiceRef_t	serviceRef,
		uint16_t	eventGroupId
	)

Disables an event group and removes all events from the group.

Returns

LE_OK – Succeeded.
LE_BAD_PARAMETER – Invalid input parameters.
LE_NOT_PERMITTED – The service is not requested by the client, or the event group is subscribed or already enabled by another client.
LE_DUPLICATE – The event group is not enabled.

Parameters

[in]	serviceRef	Service Reference.
[in]	eventGroupId	Event Group ID.

◆ taf_someipClnt_SubscribeEventGroup()

le_result_t taf_someipClnt_SubscribeEventGroup	(	taf_someipClnt_ServiceRef_t	serviceRef,
		uint16_t	eventGroupId
	)

Subscribes an event group of a service.

Returns

LE_OK – Succeeded.
LE_BAD_PARAMETER – Invalid input parameters.
LE_NOT_PERMITTED – The service is not requested by the client, or the event group is not enabled or already enabled by another client.
LE_DUPLICATE – The event group is already subscribed.

Parameters

[in]	serviceRef	Service Reference.
[in]	eventGroupId	Event Group ID.

◆ taf_someipClnt_UnsubscribeEventGroup()

le_result_t taf_someipClnt_UnsubscribeEventGroup	(	taf_someipClnt_ServiceRef_t	serviceRef,
		uint16_t	eventGroupId
	)

Unsubscribes an event group of a service.

Returns

LE_OK – Succeeded.
LE_BAD_PARAMETER – Invalid input parameters.
LE_NOT_PERMITTED – The service is not requested by the client, or the event group is not enabled or already enabled by another client.
LE_DUPLICATE – The event group is not subscribed.

Parameters

[in]	serviceRef	Service Reference.
[in]	eventGroupId	Event Group ID.

◆ taf_someipClnt_AddEventMsgHandler()

taf_someipClnt_EventMsgHandlerRef_t taf_someipClnt_AddEventMsgHandler	(	taf_someipClnt_ServiceRef_t	serviceRef,
		uint16_t	eventGroupId,
		taf_someipClnt_EventMsgHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'taf_someipClnt_EventMsg'

This event provides information on an event message.

Parameters

[in]	serviceRef	Service Reference.
[in]	eventGroupId	Event Group ID.
[in]	handlerPtr	Event Handler.
[in]	contextPtr

◆ taf_someipClnt_RemoveEventMsgHandler()

void taf_someipClnt_RemoveEventMsgHandler ( taf_someipClnt_EventMsgHandlerRef_t handlerRef )

Remove handler function for EVENT 'taf_someipClnt_EventMsg'

Parameters

[in] handlerRef

Functions

Function Documentation

◆ taf_someipClnt_GetServiceRef()

◆ taf_someipClnt_GetClientSessionRef()

◆ taf_someipClnt_AdvertiseService()

◆ taf_someipClnt_GetClientId()

◆ taf_someipClnt_GetClientIdEx()

◆ taf_someipClnt_RequestService()

◆ taf_someipClnt_RequestServiceEx()

◆ taf_someipClnt_ReleaseService()

◆ taf_someipClnt_GetState()

◆ taf_someipClnt_GetVersion()

◆ taf_someipClnt_AddStateChangeHandler()

◆ taf_someipClnt_RemoveStateChangeHandler()

◆ taf_someipClnt_CreateMsg()

◆ taf_someipClnt_SetNonRet()

◆ taf_someipClnt_SetReliable()

◆ taf_someipClnt_SetTimeout()

◆ taf_someipClnt_SetPayload()

◆ taf_someipClnt_DeleteMsg()

◆ taf_someipClnt_RequestResponse()

◆ taf_someipClnt_EnableEventGroup()

◆ taf_someipClnt_DisableEventGroup()

◆ taf_someipClnt_SubscribeEventGroup()

◆ taf_someipClnt_UnsubscribeEventGroup()

◆ taf_someipClnt_AddEventMsgHandler()

◆ taf_someipClnt_RemoveEventMsgHandler()