lib/silcutil/silcnet.h

   1 /*
   2
   3   silcnet.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 1997 - 2001 Pekka Riikonen
   8
   9   This program is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU General Public License as published by
  11   the Free Software Foundation; either version 2 of the License, or
  12   (at your option) any later version.
  13
  14   This program is distributed in the hope that it will be useful,
  15   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17   GNU General Public License for more details.
  18
  19 */
  20
  21 /****h* silcutil/SilcNetAPI
  22  *
  23  * DESCRIPTION
  24  *
  25  * SILC Net API provides various network routines for applications. It
  26  * can be used to create TCP/IP connections and servers. Various utility
  27  * functions for resolving various information is also provided.
  28  *
  29  * On WIN32 systems the SILC Net API must initialized by calling the
  30  * silc_net_win32_init and uninitialized when the application ends by
  31  * calling the silc_net_win32_uninit function. The initializing must be
  32  * done in order to assure that the SILC Net API works correctly.
  33  *
  34  ***/
  35
  36 #ifndef SILCNET_H
  37 #define SILCNET_H
  38
  39 /* Prototypes */
  40
  41 /****f* silcutil/SilcNetAPI/silc_net_create_server
  42  *
  43  * SYNOPSIS
  44  *
  45  *    int silc_net_create_server(int port, char *ip_addr);
  46  *
  47  * DESCRIPTION
  48  *
  49  *    This function creates server or daemon or listener or what ever. This
  50  *    does not fork a new process, it must be done by the caller if caller
  51  *    wants to create a child process. This is used by the SILC server.
  52  *    If argument `ip_addr' is NULL `any' address will be used. Returns
  53  *    the created socket or -1 on error.
  54  *
  55  ***/
  56 int silc_net_create_server(int port, char *ip_addr);
  57
  58 /****f* silcutil/SilcNetAPI/silc_net_close_server
  59  *
  60  * SYNOPSIS
  61  *
  62  *    void silc_net_close_server(int sock);
  63  *
  64  * DESCRIPTION
  65  *
  66  *    Closes the server by closing the socket connection.
  67  *
  68  ***/
  69 void silc_net_close_server(int sock);
  70
  71 /****f* silcutil/SilcNetAPI/silc_net_create_connection
  72  *
  73  * SYNOPSIS
  74  *
  75  *    int silc_net_create_connection(const char *local_ip, int port,
  76  *                                   const char *host);
  77  *
  78  * DESCRIPTION
  79  *
  80  *    Creates a connection (TCP/IP) to a remote host. Returns the connection
  81  *    socket or -1 on error. This blocks the process while trying to create
  82  *    the connection. If the `local_ip' is not NULL then this will bind
  83  *    the `local_ip' address to a port before creating the connection.  If
  84  *    it is NULL then this will directly create the connection.
  85  *
  86  ***/
  87 int silc_net_create_connection(const char *localhost, int port,
  88                                const char *host);
  89
  90 /****f* silcutil/SilcNetAPI/silc_net_create_connection_async
  91  *
  92  * SYNOPSIS
  93  *
  94  *    int silc_net_create_connection_async(const char *local_ip, int port,
  95  *                                         const char *host);
  96  *
  97  * DESCRIPTION
  98  *
  99  *    Creates a connection (TCP/IP) to a remote host. Returns the connection
 100  *    socket or -1 on error. This creates non-blocking socket hence the
 101  *    connection returns directly. To get the result of the connect() one
 102  *    must select() the socket and read the result after it's ready. If the
 103  *    `local_ip' is not NULL then this will bind the `local_ip' address to
 104  *    a port before creating the connection.  If it is NULL then this will
 105  *    directly create the connection.
 106  *
 107  ***/
 108 int silc_net_create_connection_async(const char *local_ip, int port,
 109                                      const char *host);
 110
 111 /****f* silcutil/SilcNetAPI/silc_net_close_connection
 112  *
 113  * SYNOPSIS
 114  *
 115  *    void silc_net_close_connection(int sock);
 116  *
 117  * DESCRIPTION
 118  *
 119  *    Closes the connection by closing the socket connection.
 120  *
 121  ***/
 122 void silc_net_close_connection(int sock);
 123
 124 /****f* silcutil/SilcNetAPI/silc_net_accept_connection
 125  *
 126  * SYNOPSIS
 127  *
 128  *    int silc_net_accept_connection(int sock);
 129  *
 130  * DESCRIPTION
 131  *
 132  *    Accepts a connection from a particular socket.
 133  *
 134  ***/
 135 int silc_net_accept_connection(int sock);
 136
 137 /****f* silcutil/SilcNetAPI/silc_net_set_socket_nonblock
 138  *
 139  * SYNOPSIS
 140  *
 141  *    int silc_net_set_socket_nonblock(int sock);
 142  *
 143  * DESCRIPTION
 144  *
 145  *    Sets the socket to non-blocking mode.
 146  *
 147  ***/
 148 int silc_net_set_socket_nonblock(int sock);
 149
 150 /****f* silcutil/SilcNetAPI/silc_net_set_socket_opt
 151  *
 152  * SYNOPSIS
 153  *
 154  *    int silc_net_set_socket_opt(int sock, int level, int option, int on);
 155  *
 156  * DESCRIPTION
 157  *
 158  *    Sets a option for a socket.  This function can be used to set
 159  *    various options for the socket.  Some of the options might be
 160  *    system specific.
 161  *
 162  ***/
 163 int silc_net_set_socket_opt(int sock, int level, int option, int on);
 164
 165 /****f* silcutil/SilcNetAPI/silc_net_get_socket_opt
 166  *
 167  * SYNOPSIS
 168  *
 169  *    int silc_net_get_socket_opt(int sock, int level, int option,
 170  *                                void *optval, int *opt_len);
 171  *
 172  * DESCRIPTION
 173  *
 174  *    Return socket options to the `optval' and `opt_len'.
 175  *
 176  ***/
 177 int silc_net_get_socket_opt(int sock, int level, int option,
 178                             void *optval, int *opt_len);
 179
 180 /****f* silcutil/SilcNetAPI/silc_net_is_ip
 181  *
 182  * SYNOPSIS
 183  *
 184  *    bool silc_net_is_ip(const char *addr);
 185  *
 186  * DESCRIPTION
 187  *
 188  *    Checks whether IP address sent as argument is valid IP address.
 189  *
 190  ***/
 191 bool silc_net_is_ip(const char *addr);
 192
 193 /****f* silcutil/SilcNetAPI/silc_net_addr2bin
 194  *
 195  * SYNOPSIS
 196  *
 197  *    bool silc_net_addr2bin(const char *addr, unsigned char *bin,
 198  *                           uint32 bin_len);
 199  *
 200  * DESCRIPTION
 201  *
 202  *    Converts the IP number string from numbers-and-dots notation to
 203  *    binary form.
 204  *
 205  ***/
 206 bool silc_net_addr2bin(const char *addr, unsigned char *bin,
 207                        uint32 bin_len);
 208
 209 /****f* silcutil/SilcNetAPI/silc_net_addr2bin_ne
 210  *
 211  * SYNOPSIS
 212  *
 213  *    bool silc_net_addr2bin_ne(const char *addr, unsigned char *bin,
 214  *                             uint32 bin_len);
 215  *
 216  * DESCRIPTION
 217  *
 218  *    Converts the IP number string from numbers-and-dots notation to
 219  *    binary form in network byte order.
 220  *
 221  ***/
 222 bool silc_net_addr2bin_ne(const char *addr, unsigned char *bin,
 223                           uint32 bin_len);
 224
 225 /****f* silcutil/SilcNetAPI/silc_net_check_host_by_sock
 226  *
 227  * SYNOPSIS
 228  *
 229  *    bool silc_net_check_host_by_sock(int sock, char **hostname, char **ip);
 230  *
 231  * DESCRIPTION
 232  *
 233  *    Performs lookups for remote name and IP address. This peforms reverse
 234  *    lookup as well to verify that the IP has FQDN.
 235  *
 236  ***/
 237 bool silc_net_check_host_by_sock(int sock, char **hostname, char **ip);
 238
 239 /****f* silcutil/SilcNetAPI/silc_net_check_local_by_sock
 240  *
 241  * SYNOPSIS
 242  *
 243  *    bool silc_net_check_local_by_sock(int sock, char **hostname, char **ip);
 244  *
 245  * DESCRIPTION
 246  *
 247  *    Performs lookups for local name and IP address. This peforms reverse
 248  *    lookup as well to verify that the IP has FQDN.
 249  *
 250  ***/
 251 bool silc_net_check_local_by_sock(int sock, char **hostname, char **ip);
 252
 253 /****f* silcutil/SilcNetAPI/silc_net_get_remote_port
 254  *
 255  * SYNOPSIS
 256  *
 257  *    uint16 silc_net_get_remote_port(int sock);
 258  *
 259  * DESCRIPTION
 260  *
 261  *    Return remote port by socket.
 262  *
 263  ***/
 264 uint16 silc_net_get_remote_port(int sock);
 265
 266 /****f* silcutil/SilcNetAPI/silc_net_get_local_port
 267  *
 268  * SYNOPSIS
 269  *
 270  *    uint16 silc_net_get_local_port(int sock);
 271  *
 272  * DESCRIPTION
 273  *
 274  *    Return local port by socket.
 275  *
 276  ***/
 277 uint16 silc_net_get_local_port(int sock);
 278
 279 /****f* silcutil/SilcNetAPI/silc_net_localhost
 280  *
 281  * SYNOPSIS
 282  *
 283  *    char *silc_net_localhost(void);
 284  *
 285  * DESCRIPTION
 286  *
 287  *    Return name of localhost.  This will also attempt to resolve
 288  *    the real hostname by the local host's IP address.  If unsuccessful
 289  *    the first found hostname is returned.
 290  *
 291  ***/
 292 char *silc_net_localhost(void);
 293
 294 #ifdef WIN32
 295
 296 /****f* silcutil/SilcNetAPI/silc_net_win32_init
 297  *
 298  * SYNOPSIS
 299  *
 300  *    bool silc_net_win32_init(void);
 301  *
 302  * DESCRIPTION
 303  *
 304  *    This is WIN32 system specific function and is used to initialize
 305  *    the network.  This must be called by all WIN32 applications.  It
 306  *    is usually called at the application's main() or WinMain() before
 307  *    calling any other SILC routine.  The application must also call
 308  *    the silc_net_win32_uninit when exiting the application.  Returns
 309  *    FALSE on error.  The network will not work if this function returns
 310  *    FALSE.
 311  *
 312  ***/
 313 bool silc_net_win32_init(void);
 314
 315 /****f* silcutil/SilcNetAPI/silc_net_win32_uninit
 316  *
 317  * SYNOPSIS
 318  *
 319  *    void silc_net_win32_init(void);
 320  *
 321  * DESCRIPTION
 322  *
 323  *    This is WIN32 system specific function and is used to uninitialize
 324  *    the network.  This must be called by all WIN32 applications.  It
 325  *    is usually called when the application is exiting.  After calling
 326  *    this function the SILC Net API routines will not work anymore.
 327  *
 328  ***/
 329 void silc_net_win32_uninit(void);
 330
 331 #endif
 332
 333 #endif