rapi_sender(3)						     Library Functions Manual						    rapi_sender(3)

NAME

       rapi_sender - Specify Resource ReSerVation Protocol (RSVP) API sender parameters

LIBRARY

       RAPI Library (librsvp.so, librsvp.a)

SYNOPSIS

       #include <rapi.h>

       int   rapi_sender(	 rapi_sid_t   Sid,	  unsigned   int   flags,	rapi_addr_t  *Lhost,	   rapi_filter_t  *SenderTemplate,
	    rapi_tspec_t *SenderTspec,	    rapi_adspec_t *SenderAdspec,      rapi_policy_t *SenderPolicy,	int TTL);

PARAMETERS

       Specifies the session handle that was returned by a successful call to the rapi_session routine.  Unused.  Points to a  rapi_addr_t  struc-
       ture that contains the source IP address and the UDP source port from which data will be sent, or is NULL.  This is an optional parameter.

	      If  the  source IP address is INADDR_ANY, the API uses the default IP address of the local host.	This is sufficient unless the host
	      is multi-homed.  The port number might be zero if the protocol for the session does not have any ports.

	      If the Lhost parameter is NULL, the application indicates that it is withdrawing its registration as a sender.   All  the  following
	      parameters  are ignored.	Points to a RSVP API (RAPI) filter specification structure that specifies the format of data packets to be
	      sent, or is NULL.  This is an optional parameter.  See RSVP(7) for a description of RAPI objects and formats.

	      If the SenderTemplate parameter is NULL, RAPI creates a sender template from the Dest and Lhost parameters.  The Dest parameter  was
	      supplied in a previous rapi_session() call.  If parameter is not NULL, the Lhost parameter is ignored.

	      This  parameter  is  required  in order to declare the sender template for a session using IP Security (IPSEC).  An IPSEC session is
	      created with the RAPI_GPI_SESSION bit set.  Points to a Tspec that defines the traffic that this sender will create.   Points  to  a
	      RAPI Adspec structure, or is NULL.  See RSVP(7) for a description of RAPI objects and formats.  Points to a sender policy structure,
	      or is NULL.  Specifies the IP Time-to-Live (TTL) value with which multicast data is sent.  This allows RSVP to send its control mes-
	      sages with the same TTL scope as the data packets.

DESCRIPTION

       The  rapi_sender()  routine defines, redefines, or deletes the parameters for a flow of data it intends to send and for which receivers can
       make reservations.  An application can call this routine more than once for the same API session, with the most recent call  taking  prece-
       dence.

       If the call to rapi_sender() succeeds, the application might receive upcalls of type RAPI_RESV_EVENT or RAPI_PATH_ERROR.

RETURN VALUES

       Upon  successful completion, the rapi_sender() routine returns zero (0).  If there is a synchronous error, the routine returns a RAPI error
       code.

RELATED INFORMATION

       Functions: rapi_dispatch(3),  rapi_event_rtn_t(3),  rapi_getfd(3),  rapi_release(3),  rapi_reserve(3),  rapi_session(3),  rapi_strerror(3),
       rapi_version(3).

       Network: RSVP(7).  delim off

																    rapi_sender(3)