gcc/ada/g-socthi.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                    G N A T . S O C K E T S . T H I N                     --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --                     Copyright (C) 2001-2008, AdaCore                     --
  10 --                                                                          --
  11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  12 -- terms of the  GNU General Public License as published  by the Free Soft- --
  13 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  17 -- for  more details.  You should have  received  a copy of the GNU General --
  18 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  19 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
  20 -- Boston, MA 02110-1301, USA.                                              --
  21 --                                                                          --
  22 -- As a special exception,  if other files  instantiate  generics from this --
  23 -- unit, or you link  this unit with other files  to produce an executable, --
  24 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  25 -- covered  by the  GNU  General  Public  License.  This exception does not --
  26 -- however invalidate  any other reasons why  the executable file  might be --
  27 -- covered by the  GNU Public License.                                      --
  28 --                                                                          --
  29 -- GNAT was originally developed  by the GNAT team at  New York University. --
  30 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  31 --                                                                          --
  32 ------------------------------------------------------------------------------
  33
  34 --  This package provides a target dependent thin interface to the sockets
  35 --  layer for use by the GNAT.Sockets package (g-socket.ads). This package
  36 --  should not be directly with'ed by an applications program.
  37
  38 --  This is the default version
  39
  40 with Interfaces.C.Strings;
  41
  42 with GNAT.OS_Lib;
  43 with GNAT.Sockets.Thin_Common;
  44
  45 with System;
  46
  47 package GNAT.Sockets.Thin is
  48
  49    --  This package is intended for hosts implementing BSD sockets with a
  50    --  standard interface. It will be used as a default for all the platforms
  51    --  that do not have a specific version of this file.
  52
  53    use Thin_Common;
  54
  55    package C renames Interfaces.C;
  56
  57    function Socket_Errno return Integer renames GNAT.OS_Lib.Errno;
  58    --  Returns last socket error number
  59
  60    function Socket_Error_Message (Errno : Integer) return C.Strings.chars_ptr;
  61    --  Returns the error message string for the error number Errno. If Errno is
  62    --  not known, returns "Unknown system error".
  63
  64    function Host_Errno return Integer;
  65    pragma Import (C, Host_Errno, "__gnat_get_h_errno");
  66    --  Returns last host error number
  67
  68    package Host_Error_Messages is
  69
  70       function Host_Error_Message
  71         (H_Errno : Integer) return C.Strings.chars_ptr;
  72       --  Returns the error message string for the host error number H_Errno.
  73       --  If H_Errno is not known, returns "Unknown system error".
  74
  75    end Host_Error_Messages;
  76
  77    --------------------------------
  78    -- Standard library functions --
  79    --------------------------------
  80
  81    function C_Accept
  82      (S       : C.int;
  83       Addr    : System.Address;
  84       Addrlen : not null access C.int) return C.int;
  85
  86    function C_Bind
  87      (S       : C.int;
  88       Name    : System.Address;
  89       Namelen : C.int) return C.int;
  90
  91    function C_Close
  92      (Fd : C.int) return C.int;
  93
  94    function C_Connect
  95      (S       : C.int;
  96       Name    : System.Address;
  97       Namelen : C.int) return C.int;
  98
  99    function C_Gethostname
 100      (Name    : System.Address;
 101       Namelen : C.int) return C.int;
 102
 103    function C_Getpeername
 104      (S       : C.int;
 105       Name    : System.Address;
 106       Namelen : not null access C.int) return C.int;
 107
 108    function C_Getsockname
 109      (S       : C.int;
 110       Name    : System.Address;
 111       Namelen : not null access C.int) return C.int;
 112
 113    function C_Getsockopt
 114      (S       : C.int;
 115       Level   : C.int;
 116       Optname : C.int;
 117       Optval  : System.Address;
 118       Optlen  : not null access C.int) return C.int;
 119
 120    function C_Inet_Addr
 121      (Cp : C.Strings.chars_ptr) return C.int;
 122
 123    function C_Ioctl
 124      (S    : C.int;
 125       Req  : C.int;
 126       Arg  : Int_Access) return C.int;
 127
 128    function C_Listen
 129      (S       : C.int;
 130       Backlog : C.int) return C.int;
 131
 132    function C_Readv
 133      (Fd     : C.int;
 134       Iov    : System.Address;
 135       Iovcnt : C.int) return C.int;
 136
 137    function C_Recv
 138      (S     : C.int;
 139       Msg   : System.Address;
 140       Len   : C.int;
 141       Flags : C.int) return C.int;
 142
 143    function C_Recvfrom
 144      (S       : C.int;
 145       Msg     : System.Address;
 146       Len     : C.int;
 147       Flags   : C.int;
 148       From    : Sockaddr_In_Access;
 149       Fromlen : not null access C.int) return C.int;
 150
 151    function C_Select
 152      (Nfds      : C.int;
 153       Readfds   : Fd_Set_Access;
 154       Writefds  : Fd_Set_Access;
 155       Exceptfds : Fd_Set_Access;
 156       Timeout   : Timeval_Access) return C.int;
 157
 158    function C_Send
 159      (S     : C.int;
 160       Msg   : System.Address;
 161       Len   : C.int;
 162       Flags : C.int) return C.int;
 163
 164    function C_Sendto
 165      (S     : C.int;
 166       Msg   : System.Address;
 167       Len   : C.int;
 168       Flags : C.int;
 169       To    : Sockaddr_In_Access;
 170       Tolen : C.int) return C.int;
 171
 172    function C_Setsockopt
 173      (S       : C.int;
 174       Level   : C.int;
 175       Optname : C.int;
 176       Optval  : System.Address;
 177       Optlen  : C.int) return C.int;
 178
 179    function C_Shutdown
 180      (S   : C.int;
 181       How : C.int) return C.int;
 182
 183    function C_Socket
 184      (Domain   : C.int;
 185       Typ      : C.int;
 186       Protocol : C.int) return C.int;
 187
 188    function C_Strerror
 189      (Errnum : C.int) return C.Strings.chars_ptr;
 190
 191    function C_System
 192      (Command : System.Address) return C.int;
 193
 194    function C_Writev
 195      (Fd     : C.int;
 196       Iov    : System.Address;
 197       Iovcnt : C.int) return C.int;
 198
 199    -------------------------------------------------------
 200    -- Signalling file descriptors for selector abortion --
 201    -------------------------------------------------------
 202
 203    package Signalling_Fds is
 204
 205       function Create (Fds : not null access Fd_Pair) return C.int;
 206       pragma Convention (C, Create);
 207       --  Create a pair of connected descriptors suitable for use with C_Select
 208       --  (used for signalling in Selector objects).
 209
 210       function Read (Rsig : C.int) return C.int;
 211       pragma Convention (C, Read);
 212       --  Read one byte of data from rsig, the read end of a pair of signalling
 213       --  fds created by Create_Signalling_Fds.
 214
 215       function Write (Wsig : C.int) return C.int;
 216       pragma Convention (C, Write);
 217       --  Write one byte of data to wsig, the write end of a pair of signalling
 218       --  fds created by Create_Signalling_Fds.
 219
 220       procedure Close (Sig : C.int);
 221       pragma Convention (C, Close);
 222       --  Close one end of a pair of signalling fds (ignoring any error)
 223
 224    end Signalling_Fds;
 225
 226    -------------------------------------------
 227    -- Nonreentrant network databases access --
 228    -------------------------------------------
 229
 230    --  The following are used only on systems that have nonreentrant
 231    --  getXXXbyYYY functions, and do NOT have corresponding getXXXbyYYY_
 232    --  functions. Currently, LynxOS is the only such system.
 233
 234    function Nonreentrant_Gethostbyname
 235      (Name : C.char_array) return Hostent_Access;
 236
 237    function Nonreentrant_Gethostbyaddr
 238      (Addr      : System.Address;
 239       Addr_Len  : C.int;
 240       Addr_Type : C.int) return Hostent_Access;
 241
 242    function Nonreentrant_Getservbyname
 243      (Name  : C.char_array;
 244       Proto : C.char_array) return Servent_Access;
 245
 246    function Nonreentrant_Getservbyport
 247      (Port  : C.int;
 248       Proto : C.char_array) return Servent_Access;
 249
 250    procedure Initialize;
 251    procedure Finalize;
 252
 253 private
 254    pragma Import (C, C_Bind, "bind");
 255    pragma Import (C, C_Close, "close");
 256    pragma Import (C, C_Gethostname, "gethostname");
 257    pragma Import (C, C_Getpeername, "getpeername");
 258    pragma Import (C, C_Getsockname, "getsockname");
 259    pragma Import (C, C_Getsockopt, "getsockopt");
 260    pragma Import (C, C_Inet_Addr, "inet_addr");
 261    pragma Import (C, C_Listen, "listen");
 262    pragma Import (C, C_Readv, "readv");
 263    pragma Import (C, C_Select, "select");
 264    pragma Import (C, C_Setsockopt, "setsockopt");
 265    pragma Import (C, C_Shutdown, "shutdown");
 266    pragma Import (C, C_Strerror, "strerror");
 267    pragma Import (C, C_System, "system");
 268    pragma Import (C, C_Writev, "writev");
 269
 270    pragma Import (C, Nonreentrant_Gethostbyname, "gethostbyname");
 271    pragma Import (C, Nonreentrant_Gethostbyaddr, "gethostbyaddr");
 272    pragma Import (C, Nonreentrant_Getservbyname, "getservbyname");
 273    pragma Import (C, Nonreentrant_Getservbyport, "getservbyport");
 274
 275 end GNAT.Sockets.Thin;