/usr/share/ada/adainclude/aws/aws-net-websocket-registry.ads is in libaws3.3.2-dev 3.3.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 | ------------------------------------------------------------------------------
-- Ada Web Server --
-- --
-- Copyright (C) 2012-2015, AdaCore --
-- --
-- This library is free software; you can redistribute it and/or modify --
-- it under terms of the GNU General Public License as published by the --
-- Free Software Foundation; either version 3, or (at your option) any --
-- later version. This library is distributed in the hope that it will be --
-- useful, but WITHOUT ANY WARRANTY; without even the implied warranty of --
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. --
-- --
-- As a special exception under Section 7 of GPL version 3, you are --
-- granted additional permissions described in the GCC Runtime Library --
-- Exception, version 3.1, as published by the Free Software Foundation. --
-- --
-- You should have received a copy of the GNU General Public License and --
-- a copy of the GCC Runtime Library Exception along with this program; --
-- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
-- <http://www.gnu.org/licenses/>. --
-- --
-- As a special exception, if other files instantiate generics from this --
-- unit, or you link this unit with other files to produce an executable, --
-- this unit does not by itself cause the resulting executable to be --
-- covered by the GNU General Public License. This exception does not --
-- however invalidate any other reasons why the executable file might be --
-- covered by the GNU Public License. --
------------------------------------------------------------------------------
pragma Ada_2012;
-- This package is used to build and register the active WebSockets. Some
-- services to send or broadcast messages are also provided.
with AWS.Status;
private with GNAT.Regexp;
package AWS.Net.WebSocket.Registry is
type Factory is not null access function
(Socket : Socket_Access;
Request : AWS.Status.Data) return Object'Class;
-- Creating and Registering WebSockets
function Constructor (URI : String) return Registry.Factory
with Pre => URI'Length > 0;
-- Get the WebObject's constructor for a specific URI
procedure Register (URI : String; Factory : Registry.Factory) with
Pre => URI'Length > 0;
-- Register a WebObject's constructor for a specific URI
procedure Register_Pattern
(Pattern : String;
Factory : Registry.Factory)
with
Pre => Pattern'Length > 0;
-- Register a WebObject's constructor for a specific URI and pattern
-- Sending messages
type Recipient is private;
function Create (URI : String; Origin : String := "") return Recipient with
Pre => URI'Length > 0;
-- A recipient with only an URI is called a broadcast as it designate all
-- registered WebSocket for this specific URI. If Origin is specified then
-- it designates a single client.
--
-- Note that both URI and Origin can be regular expressions.
function Create (Id : UID) return Recipient;
-- A recipient for a specific WebSocket
procedure Send
(To : Recipient;
Message : String;
Except_Peer : String := "";
Timeout : Duration := Forever);
-- Send a message to the WebSocket designated by Origin and URI. Do not
-- send this message to the peer whose address is given by Except_Peer.
-- Except_Peer must be the address as reported by AWS.Net.Peer_Addr. It is
-- often needed to send a message to all registered sockets except the one
-- which has sent the message triggering a response.
procedure Send
(To : Recipient;
Message : Unbounded_String;
Except_Peer : String := "";
Timeout : Duration := Forever);
-- As above but with an Unbounded_String
procedure Send
(To : Recipient;
Message : String;
Request : AWS.Status.Data;
Timeout : Duration := Forever);
-- As above but filter out the client having set the given request
procedure Send
(To : Recipient;
Message : Unbounded_String;
Request : AWS.Status.Data;
Timeout : Duration := Forever);
-- As above but with an Unbounded_String
procedure Close
(To : Recipient;
Message : String;
Except_Peer : String := "";
Timeout : Duration := Forever;
Error : Error_Type := Normal_Closure);
-- Close connections
-- Targetting a single WebSocket, these routines are equivalent to the
-- Net.WebSocket ones but are thread-safe. That is, they can be mixed
-- with other WebSocket activity to and from the clients.
procedure Send
(Socket : in out Object'Class;
Message : String;
Is_Binary : Boolean := False;
Timeout : Duration := Forever);
-- This default implementation just send a message to the client. The
-- message is sent in a single chunk (not fragmented).
procedure Send
(Socket : in out Object'Class;
Message : Unbounded_String;
Is_Binary : Boolean := False;
Timeout : Duration := Forever);
-- Same as above but can be used for large messages. The message is
-- possibly sent fragmented.
procedure Send
(Socket : in out Object'Class;
Message : Stream_Element_Array;
Is_Binary : Boolean := True;
Timeout : Duration := Forever);
-- As above but for a Stream_Element_Array
procedure Close
(Socket : in out Object'Class;
Message : String;
Timeout : Duration := Forever;
Error : Error_Type := Normal_Closure);
function Is_Registered (Id : UID) return Boolean;
-- Returns True if the WebSocket Id is registered and False otherwise
private
use GNAT.Regexp;
type Recipient_Kind is (K_UID, K_URI);
type Recipient (Kind : Recipient_Kind := K_URI) is record
case Kind is
when K_UID =>
WS_Id : UID;
when K_URI =>
URI_Set : Boolean := False;
URI : Regexp := Compile ("");
Origin_Set : Boolean := False;
Origin : Regexp := Compile ("");
end case;
end record;
procedure Start;
-- Start the WebServer's servers
procedure Shutdown;
-- Stop the WebServer's servers
function Register (WebSocket : Object'Class) return Object_Class;
-- Register a new WebSocket, returns a reference to the registered
-- WebSocket or null if it was impossible to register it.
procedure Watch (WebSocket : in out Object_Class);
-- Watched WebSocket for incoming data
end AWS.Net.WebSocket.Registry;
|