Typedefs | Functions

le_riPin_interface.h File Reference

#include "legato.h"
#include "le_riPin_common.h"

Go to the source code of this file.

Typedefs

typedef void(* le_riPin_DisconnectHandler_t) (void *)
 

Functions

void le_riPin_ConnectService (void)
 
le_result_t le_riPin_TryConnectService (void)
 
LE_FULL_API void le_riPin_SetServerDisconnectHandler (le_riPin_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
void le_riPin_DisconnectService (void)
 
le_result_t le_riPin_AmIOwnerOfRingSignal (bool *amIOwnerPtr)
 
le_result_t le_riPin_TakeRingSignal (void)
 
le_result_t le_riPin_ReleaseRingSignal (void)
 
void le_riPin_PulseRingSignal (uint32_t duration)
 

Detailed Description

Legato Ring Indicator Signal include file.

Copyright (C) Sierra Wireless Inc.

Typedef Documentation

◆ le_riPin_DisconnectHandler_t

typedef void(* le_riPin_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

◆ le_riPin_AmIOwnerOfRingSignal()

le_result_t le_riPin_AmIOwnerOfRingSignal ( bool *  amIOwnerPtr)

Check whether the application core is the current owner of the Ring Indicator signal.

Returns
  • LE_OK The function succeeded.
  • LE_FAULT The function failed.
  • LE_BAD_PARAMETER Bad input parameter.
Parameters
[out]amIOwnerPtrtrue when application core is the owner of the Ring Indicator signal,

◆ le_riPin_ConnectService()

void le_riPin_ConnectService ( void  )

Connect the current client thread to the service providing this API. Block until the service is available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client-specific Functions.

This function is created automatically.

◆ le_riPin_DisconnectService()

void le_riPin_DisconnectService ( void  )

Disconnect the current client thread from the service providing this API.

Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see Client-specific Functions.

This function is created automatically.

◆ le_riPin_PulseRingSignal()

void le_riPin_PulseRingSignal ( uint32_t  duration)

Set the Ring Indicator signal to high for configurable duration of time before lowering it.

Parameters
[in]duration[IN] Duration in ms

◆ le_riPin_ReleaseRingSignal()

le_result_t le_riPin_ReleaseRingSignal ( void  )

Release control of the Ring Indicator signal.

Returns
  • LE_OK The function succeeded.
  • LE_FAULT The function failed.
  • LE_UNSUPPORTED The platform does not support this operation.

◆ le_riPin_SetServerDisconnectHandler()

LE_FULL_API void le_riPin_SetServerDisconnectHandler ( le_riPin_DisconnectHandler_t  disconnectHandler,
void *  contextPtr 
)

Set handler called when server disconnection is detected.

When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants to continue without exiting, it should call longjmp() from inside the handler.

◆ le_riPin_TakeRingSignal()

le_result_t le_riPin_TakeRingSignal ( void  )

Take control of the Ring Indicator signal.

Returns
  • LE_OK The function succeeded.
  • LE_FAULT The function failed.
  • LE_UNSUPPORTED The platform does not support this operation.

◆ le_riPin_TryConnectService()

le_result_t le_riPin_TryConnectService ( void  )

Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client-specific Functions.

This function is created automatically.

Returns
  • LE_OK if the client connected successfully to the service.
  • LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
  • LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
  • LE_COMM_ERROR if the Service Directory cannot be reached.