rtap(1M)

NAME
     rtap - real-time application program

SYNOPSIS
     rtap [ -f file_name ]

DESCRIPTION
     Rtap is an interactive test program that drives the RSVP daemon through
     the RSVP API.  Rtap may be used either as a standalone application, or it
     may be linked directly into the RSVP daemon.

     Rtap repeatedly displays the command prompt >, and executes each command
     as it is entered.  For the standalone version, -f parameter will execute
     a stream of commands from the file file_name; at the end of that file,
     rtap will enter interactive mode.

     This man page describes the rtap program included with Release 4.0 of
     RSVP.  This version of rtap can open multiple sessions simultaneously.


COMMANDS
     Each rtap command is a single line, starting with the command verb.  The
     command verb can be abbreviated.  The command verb may optionally be
     preceded by a thread designator of the form:  `Tn' where n is a positive
     integer.  If there is no thread designator on a command, it assume the
     thread of the last designator that appeared.  When rtap starts, T1 is
     assumed.

     The basic rtap commands are as follows:.


     help or ?

          Display a complete list of rtap commands and their syntax.

     quit

          Exit.

     dest <proto> <dest addr>[:<dest port> ]

          Calls rapi_session() to define a new session by destination address
          and optional port.  Any previous session for the same thread must
          have been closed.  The required <proto> parameter must be one of the
          strings:  `udp' or 'tcp', or `proto <nn>', where <nn> is an integer
          IP protocol id.


     sender [ [ <src host>:]<src port>  <Tspec> ]

          Calls rapi_sender() to specify sender attributes and start sending
          path state.  It may be issued repeatedly to modify the sender
          attributes.  The destination from the most recent dest command is
          assumed.  If the parameters are entirely omitted, the current sender
          is removed.

          The source host (<src host>) parameter is optional; its default is
          the default IP address of the local node.  The Tspec parameter is
          required.  The TTL passed in the rapi_sender call is the most recent
          value specified in a ttl command, or the default TTL value.


     reserve <style>  [ <reservation parameters> ]

          Here <style> can be any of: wf, ff, or se.

          If <reservation parameters> is omitted, the command deletes the
          current reservation (<style> is actually irrelevant, but it must be
          present).  Otherwise, they must take the form appropriate to the
          style:


          wf

               [*] <flowspec>

          ff

               <filtspec> <flowspec> [ <filtspec> <flowspec> ] ...

          se

               [<filtspec> ...] <flowspec>

     close

          Call rapi_release() to close the session.


     ttl <integer>

          Specify TTL for use in the next sender command in this thread.


     dmask <integer>

          Specify debug mask of daemon.


     dlevel <integer>

          Specify debug level of daemon.

     confirm

          Cause next reservation request to trigger confirmation upcall.


     receive [ <receive host> ]

          Joins the multicast group indicated by receive host.  This is
          necessary for a UDP-encapsulation-only host running the RSVP daemon,
          in order for the daemon to receive Path messages.  The optional
          <receive host> parameter specifies the address of a local interface
          on which group will be joined; if it is omitted, the default
          interface will be used.

     status

          Show status of session.

     sleep <seconds>

          Delay for specified number of seconds.

     Command parameters include filterspecs, flowspecs, and Tspecs.

     Filter specs

          A filterspec is represented as <host> [:<port>], where <host> is an
          IP host name or numeric IP address and the optional parameter <port>
          is an integer.

     Flowspecs

          A flowspec is a sequence of parameters enclosed in square brackets.
          The following forms are allowed:

               [ gx <R> <S>  <r> <b> <p> <m> <M> ]

               [ cl <r> <b> <m> <M> ]

               [ g <r> <b> <delay> <service level> ]

               [ p <r> <b> <delay> <service level> ]

          The first two forms correspond to the Guaranteed and Controlled-Load
          integrated service specifications, respectively, and result in
          extended-legacy format parameter lists for the API.  The parameters
          are as defined in the corresponding service documents.  The last two
          forms are for backward compatibility; either results in a legacy
          format parameter list that will be crudely mapped into an integrated
          service Controlled-Load specification.

     Tspecs

          A Tspec is a sequence of parameters enclosed in square brackets.
          The following forms are allowed:

               [ t <r> <b> <p> <m> <M> ]

               [ g <r> <b> ]

               [ p <r> <b> ]

          The first form creates an extended-legacy format parameter list for
          a general Tspec, according to the integrated services
          specifications.  The last three forms are for backward
          compatibility; each results in a legacy format parameter list that
          will be crudely mapped into a general Integrated Services Tspec.
          Only the <r> and <b> parameters are required.


SEE ALSO
     rsvpd(1m), rstat(1m), rsvpeep(1m), rsvpfilter(1m), psifconfig(1m)


BUGS
     The sleep command works properly only for the standalone version of rtap.