rapi_session()

The rapi_session() call starts an RSVP session.

Syntax

       #include <rsvprapi.h>
       #include <netinet\in.h>

rapi_sid_t  rapi_session(
            struct sockaddr *pdest,
            int              protoId,
            int              flags,
            rapi_event_rtn_t caller,
            void            *pClientArg,
            int             *perror);

Parameters

pdest

A pointer to a sockaddr structure that defines an address and port for the destination. The sockaddr structure should be sockaddr_in. For multicast, this should be the multicast group and port. Otherwise, it should be the address and port of the receiver of the unicast data stream.

Protocol to be used for the data stream. For example, IPPROTO_UDP can be used for UDP (unicast or multicast), or IPPROTO_TCP can be used for TCP (unicast). If protoId is 0, it is set by default to IPPROTO_UPD.

No flags are defined at this time; specify 0.

A pointer to a callback function to be used for asynchronous events. The pointer may be NULL, indicating that there is no such routine.

A user supplied parameter that will be passed to the callback function. The parameter may be NULL.

A pointer to a variable in which error codes are passed.

Description

The rapi_session() call creates an RSVP API session. The session ID is an opaque non-zero value that refers to the session until it is released with rapi_release(). It is not useful to compare session IDs from different processes or from different hosts on the network.

After rapi_session() is successfully called, the application callback function may receive RAPI_PATH_EVENT messages.

Return Values and Descriptions

A non-zero return value is a new session ID which is used as a handle in subsequent calls to the API. A zero return value (NULL_SID) indicates an error, in which case an error code is in the error code variable pointed to by the perror parameter.

If the return code is zero, rapi_session() stores these values in the error code variable:

RAPI_ERR_NORSVP

The RSVP daemon in not running.

System call error; see errno.

Too many sessions.

No error.

Related Calls

rapi_release() user_rapi_callback()