adasockets/src/sockets-multicast.ads

94 lines
4.5 KiB
Ada

-----------------------------------------------------------------------------
-- --
-- ADASOCKETS COMPONENTS --
-- --
-- S O C K E T S . M U L T I C A S T --
-- --
-- S p e c --
-- --
-- Copyright (C) 1998-2020 Samuel Tardieu <sam@rfc1149.net> --
-- Copyright (C) 1999-2003 Télécom ParisTech --
-- --
-- AdaSockets 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 2, or (at your option) --
-- any later version. AdaSockets 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. --
-- See the GNU General Public License for more details. You should --
-- have received a copy of the GNU General Public License distributed --
-- with AdaSockets; see file COPYING. If not, write to the Free --
-- Software Foundation, 59 Temple Place - Suite 330, Boston, MA --
-- 02111-1307, USA. --
-- --
-- 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. --
-- --
-- The main repository for this software is located at: --
-- http://www.rfc1149.net/devel/adasockets.html --
-- --
-- If you have any question, please use the issues tracker at: --
-- https://github.com/samueltardieu/adasockets/issues --
-- --
-----------------------------------------------------------------------------
with Sockets.Types;
package Sockets.Multicast is
pragma Elaborate_Body;
-- This package aims at helping the creation of multicast sockets
type Multicast_Socket_FD is new Socket_FD with private;
Null_Multicast_Socket_FD : constant Multicast_Socket_FD;
function Create_Multicast_Socket
(Group : String;
Port : Natural;
TTL : Positive := 16;
Self_Loop : Boolean := True;
Local_If : String := "0.0.0.0")
return Multicast_Socket_FD;
-- Create a multicast socket. If Port is 0, this will be a local
-- socket with a system-chosen port.
function Create_Multicast_Socket
(Group : String;
Port : Positive;
Local_Port : Natural;
TTL : Positive := 16;
Local_If : String := "0.0.0.0")
return Multicast_Socket_FD;
-- Create a multicast socket that can only send data and is bound
-- to the local port Local_Port. Use 0 if you do not care about
-- the local port.
procedure Send (Socket : Multicast_Socket_FD;
Data : Ada.Streams.Stream_Element_Array);
-- Send data over a multicast socket
private
procedure Socket
(Sock : out Multicast_Socket_FD;
Domain : Socket_Domain := PF_INET;
Typ : Socket_Type := SOCK_STREAM);
pragma No_Return (Socket);
-- Do not call this one, it will raise Program_Error
type Multicast_Socket_FD is new Socket_FD with record
Target : Sockets.Types.Sockaddr_In;
end record;
Null_Multicast_Socket_FD : constant Multicast_Socket_FD :=
(Sockets.Null_Socket_FD with
Target => Sockets.Types.Null_Sockaddr_In);
end Sockets.Multicast;