Resource Reservation Setup Protocol APIs

The resource reservation protocol (RSVP), along with the RAPI APIs, perform your integrated services reservation. This protocol is part of the Quality of service (QoS) function that allows you to request network priority and bandwidth for TCP/IP applications. The RSVP protocol is used to load rules to the TCP/IP stack that controls these requests. These rules are called IntServ rules. QoS also allows the user to define DiffServ rules that request special handling in the network for groups of applications or connections. See Quality of service (QoS) for more information.

The six monitor APIs can be used to retrieve information on both IntServ and DiffServ rules.

Note: A thorough understanding of the RSVP protocol and the contents of Internet RFC 2205 is required to be able to use the RAPI APIs correctly. These APIs will not function unless the proper sequencing of events between the client and server is observed.

The Resource Reservation Setup Protocol APIs are:

• QgyOpenListQoSMonitorData (Open List of QoS Monitor Data) allows the user to gathering information related to QoS services.
• qtoq_accept() (Accept QoS Sockets Connection) provides simplified Quality of Service support for connection-oriented sockets communications between RSVP aware applications on a client and server.
• qtoq_close() (Close QoS Sockets Connection) is called to close the socket and Qos session that was created using the other qtoq_sockets-type APIs.
• qtoq_connect() (Make QoS Sockets Connection) provides simplified Quality of Service functionality for connection-oriented sockets communications between RSVP aware applications on a client and server.
• qtoq_ioctl() (Set QoS Sockets Control Options) provides simplified Quality of Service functionality for connectionless sockets communications between RSVP aware applications on a client and server.
• QtoqDeleteQoSMonitorData (Delete QoS Monitor Data) allows the user to delete one or more sets of collected QoS monitor data.
• QtoqEndQoSMonitor (End QoS Monitor) allows the user to stop gathering information related to QoS services.
• QtoqListSavedQoSMonitorData (List Saved QoS Monitor Data) allows the user to return a list of all collected monitor data that was saved previously.
• QtoqSaveQoSMonitorData (Save QoS Monitor Data) allows the user to save a copy of the collected QoS monitor data for future use.
• QtoqStartQoSMonitor (Start QoS Monitor) allows the user to gathering information related to QoS services.
• rapi_dispatch() (Dispatch the RAPI message handling routine defined in the rapi_session() call) dispatches the RAPI message-handling routine defined in the rapi_session() call.
• rapi_fmt_adspec() (Format a RAPI Adspec into a string suitable for printing) formats a RAPI Adspec into a string suitable for printing by converting the RAPI Adspec information that has been passed to the API into a string in the supplied buffer.
• rapi_fmt_filtspec() (Format a RAPI Filter spec into a string suitable for printing) formats a RAPI Filter spec into a string suitable for printing by converting the RAPI filtspec information that has been passed to the API into a string in the buffer that has been passed to the API.
• rapi_fmt_flowspec() (Format a RAPI Flowspec into a string suitable for printing) formats a RAPI Flowspec into a string suitable for printing by converting the RAPI flowspec information that has been passed to the API into a character string in the buffer that was passed to the API.
• rapi_fmt_tspec() (Format a RAPI Tspec into a string suitable for printing) formats a RAPI Tspec into a string suitable for printing by converting the RAPI Tspec information that has been passed to the API into a string in the buffer that has been passed to the API.
• rapi_getfd() (Get a descriptor to wait on before dispatching the RAPI message handling routine) returns the file descriptor associated with a successful rapi_session() call.
• rapi_release() (Release the currently active RAPI reservation and close the open sessions) releases the RAPI reservation that is active currently and closes the open sessions.
• rapi_reserve() (Make, modify, or delete a RAPI reservation) used to make, modify, or delete an RSVP reservation in the network.
• rapi_sender() (Identify a RAPI sender) identifies an RSVP sender to potential receivers of the data.
• rapi_session() (Create a RAPI session) returns an API session ID that is unique to this request.
• rapi_version() (Retrieve the current RAPI version) returns the RAPI version currently being used by the RSVP agent.