doc/modbus_new_tcp.txt

   1 modbus_new_tcp(3)
   2 =================
   3
   4
   5 NAME
   6 ----
   7 modbus_new_tcp - create a libmodbus context for TCP/IPv4
   8
   9
  10 SYNOPSIS
  11 --------
  12 *modbus_t *modbus_new_tcp(const char *'ip', int 'port');*
  13
  14
  15 DESCRIPTION
  16 -----------
  17 The *modbus_new_tcp()* function shall allocate and initialize a modbus_t
  18 structure to communicate with a Modbus TCP IPv4 server.
  19
  20 The _ip_ argument specifies the IP address of the server to which the client
  21 wants to establish a connection. A NULL value can be used to listen any addresses in
  22 server mode.
  23
  24 The _port_ argument is the TCP port to use. Set the port to
  25 `MODBUS_TCP_DEFAULT_PORT` to use the default one (502). It’s convenient to use a
  26 port number greater than or equal to 1024 because it’s not necessary to have
  27 administrator privileges.
  28
  29
  30 RETURN VALUE
  31 ------------
  32 The function shall return a pointer to a *modbus_t* structure if
  33 successful. Otherwise it shall return NULL and set errno to one of the values
  34 defined below.
  35
  36
  37 ERRORS
  38 ------
  39 *EINVAL*::
  40 An invalid IP address was given.
  41
  42 *ENOMEM*::
  43 Out of memory. Possibly, the application hits its memory limit and/or whole
  44 system is running out of memory.
  45
  46
  47 EXAMPLE
  48 -------
  49 [source,c]
  50 -------------------
  51 modbus_t *ctx;
  52
  53 ctx = modbus_new_tcp("127.0.0.1", 1502);
  54 if (ctx == NULL) {
  55     fprintf(stderr, "Unable to allocate libmodbus context\n");
  56     return -1;
  57 }
  58
  59 if (modbus_connect(ctx) == -1) {
  60     fprintf(stderr, "Connection failed: %s\n", modbus_strerror(errno));
  61     modbus_free(ctx);
  62     return -1;
  63 }
  64 -------------------
  65
  66 SEE ALSO
  67 --------
  68 linkmb:modbus_tcp_listen[3]
  69 linkmb:modbus_free[3]
  70
  71
  72 AUTHORS
  73 -------
  74 The libmodbus documentation was written by Stéphane Raimbault
  75 <stephane.raimbault@gmail.com>