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, const 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, void *bin, uint32 bin_len);
 207
 208 /****f* silcutil/SilcNetAPI/silc_net_addr2bin_ne
 209  *
 210  * SYNOPSIS
 211  *
 212  *    bool silc_net_addr2bin_ne(const char *addr, unsigned char *bin,
 213  *                             uint32 bin_len);
 214  *
 215  * DESCRIPTION
 216  *
 217  *    Converts the IP number string from numbers-and-dots notation to
 218  *    binary form in network byte order.
 219  *
 220  ***/
 221 bool silc_net_addr2bin_ne(const char *addr, unsigned char *bin,
 222                           uint32 bin_len);
 223
 224 /****f* silcutil/SilcNetAPI/silc_net_check_host_by_sock
 225  *
 226  * SYNOPSIS
 227  *
 228  *    bool silc_net_check_host_by_sock(int sock, char **hostname, char **ip);
 229  *
 230  * DESCRIPTION
 231  *
 232  *    Performs lookups for remote name and IP address. This peforms reverse
 233  *    lookup as well to verify that the IP has FQDN.
 234  *
 235  ***/
 236 bool silc_net_check_host_by_sock(int sock, char **hostname, char **ip);
 237
 238 /****f* silcutil/SilcNetAPI/silc_net_check_local_by_sock
 239  *
 240  * SYNOPSIS
 241  *
 242  *    bool silc_net_check_local_by_sock(int sock, char **hostname, char **ip);
 243  *
 244  * DESCRIPTION
 245  *
 246  *    Performs lookups for local name and IP address. This peforms reverse
 247  *    lookup as well to verify that the IP has FQDN.
 248  *
 249  ***/
 250 bool silc_net_check_local_by_sock(int sock, char **hostname, char **ip);
 251
 252 /****f* silcutil/SilcNetAPI/silc_net_get_remote_port
 253  *
 254  * SYNOPSIS
 255  *
 256  *    uint16 silc_net_get_remote_port(int sock);
 257  *
 258  * DESCRIPTION
 259  *
 260  *    Return remote port by socket.
 261  *
 262  ***/
 263 uint16 silc_net_get_remote_port(int sock);
 264
 265 /****f* silcutil/SilcNetAPI/silc_net_get_local_port
 266  *
 267  * SYNOPSIS
 268  *
 269  *    uint16 silc_net_get_local_port(int sock);
 270  *
 271  * DESCRIPTION
 272  *
 273  *    Return local port by socket.
 274  *
 275  ***/
 276 uint16 silc_net_get_local_port(int sock);
 277
 278 /****f* silcutil/SilcNetAPI/silc_net_localhost
 279  *
 280  * SYNOPSIS
 281  *
 282  *    char *silc_net_localhost(void);
 283  *
 284  * DESCRIPTION
 285  *
 286  *    Return name of localhost.  This will also attempt to resolve
 287  *    the real hostname by the local host's IP address.  If unsuccessful
 288  *    the first found hostname is returned.
 289  *
 290  ***/
 291 char *silc_net_localhost(void);
 292
 293 /****f* silcutil/SilcNetAPI/silc_net_localip
 294  *
 295  * SYNOPSIS
 296  *
 297  *    char *silc_net_localip(void)
 298  *
 299  * DESCRIPTION
 300  *
 301  *    Return IP of localhost.
 302  *
 303  ***/
 304 char *silc_net_localip(void);
 305
 306 #ifdef WIN32
 307
 308 /****f* silcutil/SilcNetAPI/silc_net_win32_init
 309  *
 310  * SYNOPSIS
 311  *
 312  *    bool silc_net_win32_init(void);
 313  *
 314  * DESCRIPTION
 315  *
 316  *    This is WIN32 system specific function and is used to initialize
 317  *    the network.  This must be called by all WIN32 applications.  It
 318  *    is usually called at the application's main() or WinMain() before
 319  *    calling any other SILC routine.  The application must also call
 320  *    the silc_net_win32_uninit when exiting the application.  Returns
 321  *    FALSE on error.  The network will not work if this function returns
 322  *    FALSE.
 323  *
 324  ***/
 325 bool silc_net_win32_init(void);
 326
 327 /****f* silcutil/SilcNetAPI/silc_net_win32_uninit
 328  *
 329  * SYNOPSIS
 330  *
 331  *    void silc_net_win32_init(void);
 332  *
 333  * DESCRIPTION
 334  *
 335  *    This is WIN32 system specific function and is used to uninitialize
 336  *    the network.  This must be called by all WIN32 applications.  It
 337  *    is usually called when the application is exiting.  After calling
 338  *    this function the SILC Net API routines will not work anymore.
 339  *
 340  ***/
 341 void silc_net_win32_uninit(void);
 342
 343 #endif
 344
 345 #endif