le_limit_interface.h

Go to the documentation of this file.
    1 
    2 
    3 /*
    4  * ====================== WARNING ======================
    5  *
    6  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
    7  * DO NOT MODIFY IN ANY WAY.
    8  *
    9  * ====================== WARNING ======================
   10  */
   11 
   12 /**
   13  * @page c_limit Limit Definitions
   14  *
   15  * @ref le_limit_interface.h "API Reference"
   16  *
   17  * This file defines limit definitions used by other APIs.
   18  *
   19  * <HR>
   20  *
   21  * Copyright (C) Sierra Wireless Inc.
   22  */
   23 /**
   24  * @file le_limit_interface.h
   25  *
   26  * Legato @ref c_limit include file.
   27  *
   28  * Copyright (C) Sierra Wireless Inc.
   29  */
   30 
   31 #ifndef LE_LIMIT_INTERFACE_H_INCLUDE_GUARD
   32 #define LE_LIMIT_INTERFACE_H_INCLUDE_GUARD
   33 
   34 
   35 #include "legato.h"
   36 
   37 
   38 //--------------------------------------------------------------------------------------------------
   39 /**
   40  * Type for handler called when a server disconnects.
   41  */
   42 //--------------------------------------------------------------------------------------------------
   43 typedef void (*le_limit_DisconnectHandler_t)(void *);
   44 
   45 //--------------------------------------------------------------------------------------------------
   46 /**
   47  *
   48  * Connect the current client thread to the service providing this API. Block until the service is
   49  * available.
   50  *
   51  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
   52  * called before any other functions in this API.  Normally, ConnectService is automatically called
   53  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
   54  *
   55  * This function is created automatically.
   56  */
   57 //--------------------------------------------------------------------------------------------------
   58 void le_limit_ConnectService
   59 (
   60     void
   61 );
   62 
   63 //--------------------------------------------------------------------------------------------------
   64 /**
   65  *
   66  * Try to connect the current client thread to the service providing this API. Return with an error
   67  * if the service is not available.
   68  *
   69  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
   70  * called before any other functions in this API.  Normally, ConnectService is automatically called
   71  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
   72  *
   73  * This function is created automatically.
   74  *
   75  * @return
   76  *  - LE_OK if the client connected successfully to the service.
   77  *  - LE_UNAVAILABLE if the server is not currently offering the service to which the client is
   78  *    bound.
   79  *  - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
   80  *  - LE_COMM_ERROR if the Service Directory cannot be reached.
   81  */
   82 //--------------------------------------------------------------------------------------------------
   83 le_result_t le_limit_TryConnectService
   84 (
   85     void
   86 );
   87 
   88 //--------------------------------------------------------------------------------------------------
   89 /**
   90  * Set handler called when server disconnection is detected.
   91  *
   92  * When a server connection is lost, call this handler then exit with LE_FATAL.  If a program wants
   93  * to continue without exiting, it should call longjmp() from inside the handler.
   94  */
   95 //--------------------------------------------------------------------------------------------------
   96 void le_limit_SetServerDisconnectHandler
   97 (
   98     le_limit_DisconnectHandler_t disconnectHandler,
   99     void *contextPtr
  100 );
  101 
  102 //--------------------------------------------------------------------------------------------------
  103 /**
  104  *
  105  * Disconnect the current client thread from the service providing this API.
  106  *
  107  * Normally, this function doesn't need to be called. After this function is called, there's no
  108  * longer a connection to the service, and the functions in this API can't be used. For details, see
  109  * @ref apiFilesC_client.
  110  *
  111  * This function is created automatically.
  112  */
  113 //--------------------------------------------------------------------------------------------------
  114 void le_limit_DisconnectService
  115 (
  116     void
  117 );
  118 
  119 
  120 //--------------------------------------------------------------------------------------------------
  121 /**
  122  * Maximum length of application names.
  123  */
  124 //--------------------------------------------------------------------------------------------------
  125 #define LE_LIMIT_APP_NAME_LEN 47
  126 
  127 //--------------------------------------------------------------------------------------------------
  128 /**
  129  * Maximum length of process names.
  130  */
  131 //--------------------------------------------------------------------------------------------------
  132 #define LE_LIMIT_PROC_NAME_LEN 47
  133 
  134 //--------------------------------------------------------------------------------------------------
  135 /**
  136  * Maximum string length of paths.
  137  */
  138 //--------------------------------------------------------------------------------------------------
  139 #define LE_LIMIT_MAX_PATH_LEN 511
  140 
  141 //--------------------------------------------------------------------------------------------------
  142 /**
  143  * Maximum string length of priority names.
  144  */
  145 //--------------------------------------------------------------------------------------------------
  146 #define LE_LIMIT_MAX_PRIORITY_NAME_LEN 6
  147 
  148 //--------------------------------------------------------------------------------------------------
  149 /**
  150  * Maximum string length of argument lists.
  151  */
  152 //--------------------------------------------------------------------------------------------------
  153 #define LE_LIMIT_MAX_ARGS_STR_LEN 511
  154 
  155 //--------------------------------------------------------------------------------------------------
  156 /**
  157  * Length of a MD5 string.
  158  */
  159 //--------------------------------------------------------------------------------------------------
  160 #define LE_LIMIT_MD5_STR_LEN 32
  161 
  162 #endif // LE_LIMIT_INTERFACE_H_INCLUDE_GUARD
le_limit_ConnectService
void le_limit_ConnectService(void)


le_result_t
le_result_t
Definition: le_basics.h:35


le_limit_DisconnectService
void le_limit_DisconnectService(void)


le_limit_DisconnectHandler_t
void(* le_limit_DisconnectHandler_t)(void *)
Definition: le_limit_interface.h:43


le_limit_TryConnectService
le_result_t le_limit_TryConnectService(void)



le_limit_SetServerDisconnectHandler
void le_limit_SetServerDisconnectHandler(le_limit_DisconnectHandler_t disconnectHandler, void *contextPtr)