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-2009, 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 with System.CRTL;
  47
  48 package GNAT.Sockets.Thin is
  49
  50    --  This package is intended for hosts implementing BSD sockets with a
  51    --  standard interface. It will be used as a default for all the platforms
  52    --  that do not have a specific version of this file.
  53
  54    use Thin_Common;
  55
  56    package C renames Interfaces.C;
  57
  58    use type System.CRTL.ssize_t;
  59
  60    function Socket_Errno return Integer renames GNAT.OS_Lib.Errno;
  61    --  Returns last socket error number
  62
  63    function Socket_Error_Message (Errno : Integer) return C.Strings.chars_ptr;
  64    --  Returns the error message string for the error number Errno. If Errno is
  65    --  not known, returns "Unknown system error".
  66
  67    function Host_Errno return Integer;
  68    pragma Import (C, Host_Errno, "__gnat_get_h_errno");
  69    --  Returns last host error number
  70
  71    package Host_Error_Messages is
  72
  73       function Host_Error_Message
  74         (H_Errno : Integer) return C.Strings.chars_ptr;
  75       --  Returns the error message string for the host error number H_Errno.
  76       --  If H_Errno is not known, returns "Unknown system error".
  77
  78    end Host_Error_Messages;
  79
  80    --------------------------------
  81    -- Standard library functions --
  82    --------------------------------
  83
  84    function C_Accept
  85      (S       : C.int;
  86       Addr    : System.Address;
  87       Addrlen : not null access C.int) return C.int;
  88
  89    function C_Bind
  90      (S       : C.int;
  91       Name    : System.Address;
  92       Namelen : C.int) return C.int;
  93
  94    function C_Close
  95      (Fd : C.int) return C.int;
  96
  97    function C_Connect
  98      (S       : C.int;
  99       Name    : System.Address;
 100       Namelen : C.int) return C.int;
 101
 102    function C_Gethostname
 103      (Name    : System.Address;
 104       Namelen : C.int) return C.int;
 105
 106    function C_Getpeername
 107      (S       : C.int;
 108       Name    : System.Address;
 109       Namelen : not null access C.int) return C.int;
 110
 111    function C_Getsockname
 112      (S       : C.int;
 113       Name    : System.Address;
 114       Namelen : not null access C.int) return C.int;
 115
 116    function C_Getsockopt
 117      (S       : C.int;
 118       Level   : C.int;
 119       Optname : C.int;
 120       Optval  : System.Address;
 121       Optlen  : not null access C.int) return C.int;
 122
 123    function Socket_Ioctl
 124      (S   : C.int;
 125       Req : C.int;
 126       Arg : access C.int) return C.int;
 127
 128    function C_Listen
 129      (S       : C.int;
 130       Backlog : C.int) return C.int;
 131
 132    function C_Recv
 133      (S     : C.int;
 134       Msg   : System.Address;
 135       Len   : C.int;
 136       Flags : C.int) return C.int;
 137
 138    function C_Recvfrom
 139      (S       : C.int;
 140       Msg     : System.Address;
 141       Len     : C.int;
 142       Flags   : C.int;
 143       From    : System.Address;
 144       Fromlen : not null access C.int) return C.int;
 145
 146    function C_Recvmsg
 147      (S     : C.int;
 148       Msg   : System.Address;
 149       Flags : C.int) return System.CRTL.ssize_t;
 150
 151    function C_Select
 152      (Nfds      : C.int;
 153       Readfds   : access Fd_Set;
 154       Writefds  : access Fd_Set;
 155       Exceptfds : access Fd_Set;
 156       Timeout   : Timeval_Access) return C.int;
 157
 158    function C_Sendmsg
 159      (S     : C.int;
 160       Msg   : System.Address;
 161       Flags : C.int) return System.CRTL.ssize_t;
 162
 163    function C_Sendto
 164      (S     : C.int;
 165       Msg   : System.Address;
 166       Len   : C.int;
 167       Flags : C.int;
 168       To    : System.Address;
 169       Tolen : C.int) return C.int;
 170
 171    function C_Setsockopt
 172      (S       : C.int;
 173       Level   : C.int;
 174       Optname : C.int;
 175       Optval  : System.Address;
 176       Optlen  : C.int) return C.int;
 177
 178    function C_Shutdown
 179      (S   : C.int;
 180       How : C.int) return C.int;
 181
 182    function C_Socket
 183      (Domain   : C.int;
 184       Typ      : C.int;
 185       Protocol : C.int) return C.int;
 186
 187    function C_System
 188      (Command : System.Address) return C.int;
 189
 190    -------------------------------------------------------
 191    -- Signalling file descriptors for selector abortion --
 192    -------------------------------------------------------
 193
 194    package Signalling_Fds is
 195
 196       function Create (Fds : not null access Fd_Pair) return C.int;
 197       pragma Convention (C, Create);
 198       --  Create a pair of connected descriptors suitable for use with C_Select
 199       --  (used for signalling in Selector objects).
 200
 201       function Read (Rsig : C.int) return C.int;
 202       pragma Convention (C, Read);
 203       --  Read one byte of data from rsig, the read end of a pair of signalling
 204       --  fds created by Create_Signalling_Fds.
 205
 206       function Write (Wsig : C.int) return C.int;
 207       pragma Convention (C, Write);
 208       --  Write one byte of data to wsig, the write end of a pair of signalling
 209       --  fds created by Create_Signalling_Fds.
 210
 211       procedure Close (Sig : C.int);
 212       pragma Convention (C, Close);
 213       --  Close one end of a pair of signalling fds (ignoring any error)
 214
 215    end Signalling_Fds;
 216
 217    -------------------------------------------
 218    -- Nonreentrant network databases access --
 219    -------------------------------------------
 220
 221    --  The following are used only on systems that have nonreentrant
 222    --  getXXXbyYYY functions, and do NOT have corresponding getXXXbyYYY_
 223    --  functions. Currently, LynxOS is the only such system.
 224
 225    function Nonreentrant_Gethostbyname
 226      (Name : C.char_array) return Hostent_Access;
 227
 228    function Nonreentrant_Gethostbyaddr
 229      (Addr      : System.Address;
 230       Addr_Len  : C.int;
 231       Addr_Type : C.int) return Hostent_Access;
 232
 233    function Nonreentrant_Getservbyname
 234      (Name  : C.char_array;
 235       Proto : C.char_array) return Servent_Access;
 236
 237    function Nonreentrant_Getservbyport
 238      (Port  : C.int;
 239       Proto : C.char_array) return Servent_Access;
 240
 241    procedure Initialize;
 242    procedure Finalize;
 243
 244 private
 245    pragma Import (C, C_Bind, "bind");
 246    pragma Import (C, C_Close, "close");
 247    pragma Import (C, C_Gethostname, "gethostname");
 248    pragma Import (C, C_Getpeername, "getpeername");
 249    pragma Import (C, C_Getsockname, "getsockname");
 250    pragma Import (C, C_Getsockopt, "getsockopt");
 251    pragma Import (C, C_Listen, "listen");
 252    pragma Import (C, C_Select, "select");
 253    pragma Import (C, C_Setsockopt, "setsockopt");
 254    pragma Import (C, C_Shutdown, "shutdown");
 255    pragma Import (C, C_System, "system");
 256
 257    pragma Import (C, Nonreentrant_Gethostbyname, "gethostbyname");
 258    pragma Import (C, Nonreentrant_Gethostbyaddr, "gethostbyaddr");
 259    pragma Import (C, Nonreentrant_Getservbyname, "getservbyname");
 260    pragma Import (C, Nonreentrant_Getservbyport, "getservbyport");
 261
 262 end GNAT.Sockets.Thin;