le_atDefs_common.h

    1 
    2 /*
    3  * ====================== WARNING ======================
    4  *
    5  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
    6  * DO NOT MODIFY IN ANY WAY.
    7  *
    8  * ====================== WARNING ======================
    9  */
   10 /**
   11  * @file le_atDefs_common.h
   12  *
   13  * Type definitions for le_atDefs.
   14  *
   15  */
   16 #ifndef LE_ATDEFS_COMMON_H_INCLUDE_GUARD
   17 #define LE_ATDEFS_COMMON_H_INCLUDE_GUARD
   18 
   19 
   20 #include "legato.h"
   21 
   22 #define IFGEN_LE_ATDEFS_PROTOCOL_ID "c1292f59ced10cc615b544c7bc2fd8e5"
   23 #define IFGEN_LE_ATDEFS_MSG_SIZE 9
   24 /** @addtogroup le_atDefs
   25  *  @{ **/
   26 
   27 
   28 //--------------------------------------------------------------------------------------------------
   29 /**
   30  * Command string maximum length.
   31  *
   32  * @warning Special characters cost more than one byte
   33  *
   34  */
   35 //--------------------------------------------------------------------------------------------------
   36 #define LE_ATDEFS_COMMAND_MAX_LEN 511
   37 
   38 //--------------------------------------------------------------------------------------------------
   39 /**
   40  * Command string maximum length.
   41  * One extra byte is added for the null character.
   42  */
   43 //--------------------------------------------------------------------------------------------------
   44 #define LE_ATDEFS_COMMAND_MAX_BYTES 512
   45 
   46 //--------------------------------------------------------------------------------------------------
   47 /**
   48  * Parameter string maximum length.
   49  *
   50  * @warning Special characters cost more than one byte
   51  *
   52  */
   53 //--------------------------------------------------------------------------------------------------
   54 #define LE_ATDEFS_PARAMETER_MAX_LEN 128
   55 
   56 //--------------------------------------------------------------------------------------------------
   57 /**
   58  * Parameter string maximum length.
   59  * One extra byte is added for the null character.
   60  */
   61 //--------------------------------------------------------------------------------------------------
   62 #define LE_ATDEFS_PARAMETER_MAX_BYTES 129
   63 
   64 //--------------------------------------------------------------------------------------------------
   65 /**
   66  * AT command response maximum length.
   67  *
   68  * @warning Special characters cost more than one byte
   69  *
   70  */
   71 //--------------------------------------------------------------------------------------------------
   72 #define LE_ATDEFS_RESPONSE_MAX_LEN 520
   73 
   74 //--------------------------------------------------------------------------------------------------
   75 /**
   76  * AT command response maximum length.
   77  * One extra byte is added for the null character.
   78  */
   79 //--------------------------------------------------------------------------------------------------
   80 #define LE_ATDEFS_RESPONSE_MAX_BYTES 521
   81 
   82 //--------------------------------------------------------------------------------------------------
   83 /**
   84  * Maximum number of bytes in an unsolicited response (not including the null-terminator).
   85  *
   86  * @warning Special characters cost more than one byte
   87  *
   88  */
   89 //--------------------------------------------------------------------------------------------------
   90 #define LE_ATDEFS_UNSOLICITED_MAX_LEN 256
   91 
   92 //--------------------------------------------------------------------------------------------------
   93 /**
   94  * Maximum number of bytes in an unsolicited response (including the null-terminator).
   95  */
   96 //--------------------------------------------------------------------------------------------------
   97 #define LE_ATDEFS_UNSOLICITED_MAX_BYTES 257
   98 
   99 //--------------------------------------------------------------------------------------------------
  100 /**
  101  * Maximum number of bytes in a text message (not including the null-terminator).
  102  *
  103  * @warning Special characters cost more than one byte
  104  *
  105  */
  106 //--------------------------------------------------------------------------------------------------
  107 #define LE_ATDEFS_TEXT_MAX_LEN 4095
  108 
  109 //--------------------------------------------------------------------------------------------------
  110 /**
  111  * Maximum number of bytes in an text message (including the null-terminator).
  112  */
  113 //--------------------------------------------------------------------------------------------------
  114 #define LE_ATDEFS_TEXT_MAX_BYTES 4096
  115 
  116 //--------------------------------------------------------------------------------------------------
  117 /**
  118  * Command default timeout (in ms)
  119  */
  120 //--------------------------------------------------------------------------------------------------
  121 #define LE_ATDEFS_COMMAND_DEFAULT_TIMEOUT 30000
  122 
  123 //--------------------------------------------------------------------------------------------------
  124 /**
  125  *  CME error pattern
  126  */
  127 //--------------------------------------------------------------------------------------------------
  128 #define LE_ATDEFS_CME_ERROR "+CME ERROR: "
  129 
  130 //--------------------------------------------------------------------------------------------------
  131 /**
  132  *  CMS error pattern
  133  */
  134 //--------------------------------------------------------------------------------------------------
  135 #define LE_ATDEFS_CMS_ERROR "+CMS ERROR: "
  136 
  137 
  138 //--------------------------------------------------------------------------------------------------
  139 /**
  140  * Get if this client bound locally.
  141  */
  142 //--------------------------------------------------------------------------------------------------
  143 LE_SHARED bool ifgen_le_atDefs_HasLocalBinding
  144 (
  145     void
  146 );
  147 
  148 
  149 //--------------------------------------------------------------------------------------------------
  150 /**
  151  * Init data that is common across all threads
  152  */
  153 //--------------------------------------------------------------------------------------------------
  154 LE_SHARED void ifgen_le_atDefs_InitCommonData
  155 (
  156     void
  157 );
  158 
  159 
  160 //--------------------------------------------------------------------------------------------------
  161 /**
  162  * Perform common initialization and open a session
  163  */
  164 //--------------------------------------------------------------------------------------------------
  165 LE_SHARED le_result_t ifgen_le_atDefs_OpenSession
  166 (
  167     le_msg_SessionRef_t _ifgen_sessionRef,
  168     bool isBlocking
  169 );
  170 /** @} **/
  171 #endif // LE_ATDEFS_COMMON_H_INCLUDE_GUARD
LE_SHARED
#define LE_SHARED
Definition: le_basics.h:287
le_result_t
le_result_t
Definition: le_basics.h:46
le_msg_SessionRef_t
struct le_msg_Session * le_msg_SessionRef_t
Definition: le_messaging.h:860
legato.h