doc/modbus_reply_exception.txt

   1 modbus_reply_exception(3)
   2 =========================
   3
   4 NAME
   5 ----
   6 modbus_reply_exception - send an exception reponse
   7
   8
   9 SYNOPSIS
  10 --------
  11 *int modbus_reply_exception(modbus_t *'ctx', const uint8_t *'req', unsigned int 'exception_code');
  12
  13
  14 DESCRIPTION
  15 -----------
  16 The *modbus_reply_exception()* function shall send an exception response based
  17 on the 'exception_code' in argument.
  18
  19 The libmodbus provides the following exception codes:
  20
  21 * MODBUS_EXCEPTION_ILLEGAL_FUNCTION (1)
  22 * MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS (2)
  23 * MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE (3)
  24 * MODBUS_EXCEPTION_SLAVE_OR_SERVER_FAILURE (4)
  25 * MODBUS_EXCEPTION_ACKNOWLEDGE (5)
  26 * MODBUS_EXCEPTION_SLAVE_OR_SERVER_BUSY (6)
  27 * MODBUS_EXCEPTION_NEGATIVE_ACKNOWLEDGE (7)
  28 * MODBUS_EXCEPTION_MEMORY_PARITY (8)
  29 * MODBUS_EXCEPTION_NOT_DEFINED (9)
  30 * MODBUS_EXCEPTION_GATEWAY_PATH (10)
  31 * MODBUS_EXCEPTION_GATEWAY_TARGET (11)
  32
  33 The initial request _req_ is required to build a valid response.
  34
  35
  36 RETURN VALUE
  37 ------------
  38 The function shall return the length of the response sent if
  39 successful. Otherwise it shall return -1 and set errno.
  40
  41
  42 ERRORS
  43 ------
  44 *EINVAL*::
  45 The exception code is invalid
  46
  47
  48 SEE ALSO
  49 --------
  50 linkmb:modbus_reply[3]
  51 linkmb:libmodbus[7]
  52
  53
  54 AUTHORS
  55 -------
  56 The libmodbus documentation was written by Stéphane Raimbault
  57 <stephane.raimbault@gmail.com>