using.txt

一个著名的SIP协议栈

     Authentication-Info
     Authorization (*)
     Proxy-Authenticate (*)
     Proxy-Authorization (*)
     WWW-Authenticate (*)

CSeqCategory
============
  RFC name:
    CSeq
  Description:
    Places the message in sequence in the call.
  Example:
    CSeq: 314159 INVITE
  Parts:
    RFC Name          accessor            reSIP type      settable
    --------------------------------------------------------------
                      sequence()          int             yes
    Method            method()            MethodTypes     yes
                      unknownMethodName() Data            no
   RFC Headers:
     CSeq

CallID
======
  RFC name:
    Call-ID
  Description:
    Uniquely identifies the call.
  Example:
    Call-ID: [e-mail]
  Parts:
    RFC Name          accessor        reSIP type      settable
    ----------------------------------------------------------
                      value()         Data            yes  
   RFC Headers:
     Call-ID

DateCategory
============
  RFC name:
    SIP-date
  Description:
    Human readable date string.
  Example:
    Date: Sat, 13 Nov 2010 23:29:00 GMT
  Parts:
    RFC Name          accessor        reSIP type      settable
    ----------------------------------------------------------
    wkday             dayOfWeek()     DayOfWeek       yes
    date1
                      dayOfMonth      int             yes
                      month()         int             yes
                      year()          int             yes
    time
                      hour()          int             yes
                      minute()        int             yes
                      second()        int             yes
   RFC Headers:
     Date

GenericUri      
==========
  RFC name:
    absoluteURI
  Description:
    Non-structured human readable URI.
  Example:
    Alert-Info: <http://www.example.com/sounds/moo.wav>
  Parts:
    RFC Name          accessor        reSIP type      settable
    ----------------------------------------------------------
                      uri()           Data            yes
  RFC Headers:
   Alert-Info
   Call-Info
   Error-Info

IntegerCategory 
===============
  RFC name:
    1*DIGIT
  Description:
    An integer.
  Example:
    Max-Forwards: 70
  Parts:
    RFC Name          accessor        reSIP type      settable
    ----------------------------------------------------------
                      value()         int             yes
    comment           comment()       Data            yes
  RFC Headers:
    Content-Length // note: does not permit (comment)
    Max-Forwards   // note: does not permit (comment)
    Min-Expires    // note: does not permit (comment)
    Retry-After

ExpiresCategory
===============
  RFC name:

  Description:
    Seconds to expiration.
  Example:
    Expires: 5
  Parts:
    RFC Name          accessor        reSIP type      settable
    ----------------------------------------------------------
                      value()         int             yes
  RFC Headers:
    Expires

Mime            
============
  RFC name:
    media-type
  Description:
    Mime type and sub-type.
  Example:
    Content-Type: application/sdp
  Parts:
    RFC Name          accessor        reSIP type      settable
    ----------------------------------------------------------
    m-type            type()          Data            yes
    m-subtype         subType()       Data            yes
  RFC Headers:
    Accept (*)
    Content-Type
   
NameAddr        
============
  RFC name:
    name-addr
  Description:
    URI and display name.
  Example:
    To: Bob <sip:[e-mail]>
  Parts:
    RFC Name          accessor        reSIP type      settable
    ----------------------------------------------------------
    display-name      displayName()   Data            yes
    addr-spec         uri()           Uri             yes
  RFC Headers:
    Contact (*)
    From
    Record-Route (*)
    Refer-To
    Referred-By
    Reply-To
    Route (*)
    To
    
StringCategory  
==============
  RFC name:
    TEXT-UTF8-TRIM
  Description:
    Unstructured human readable text.
  Example:
    Organization: Boxes by Bob
  Parts:
    RFC Name          accessor        reSIP type      settable
    ----------------------------------------------------------
                      value()         Data            yes
  RFC Headers:
    Content-Transfer-Encoding
    Organization
    Server
    Subject
    User-Agent
    Timestamp
    extension-header (*)

Token           
=====
  RFC name:
    token
  Description:
    A word.
  Example:
    Accept-Encoding: gzip
  Parts:
    RFC Name          accessor        reSIP type      settable
    ----------------------------------------------------------
                      value()         Data            yes
  RFC Headers:
    Accept-Encoding (*)
    Accept-Language (*)
    Allow (*)
    Allow-Events (*)
    Content-Disposition
    Content-Encoding
    Content-Language (*)
    Event
    Mime-Version
    Priority
    Proxy-Require (*)
    Require (*)
    Security-Client (*)
    Security-Server (*)
    Security-Verify (*)
    Subscription-State (*)
    Supported (*)
    Unsupported (*)

Via             
============
  RFC name:
    via-parm
  Description:
    Via entry.
  Example:
    Via: SIP/2.0/UDP pc33.atlanta.com;branch=z9hG4bK776asdhds
  Parts:
    RFC Name          accessor          reSIP type      settable
    ------------------------------------------------------------
    protocol-name     protocolName()    Data            yes
    protocol-version  protocolVersion() Data            yes
    transport         transport()       Data            yes
    host              sentHost()        Data            yes
    port              sentPort()        int             yes
  RFC RFC Headers:
    Via (*)

WarningCategory 
============
  RFC name:
    warning-value
  Description:

  Example:

  Parts:
    RFC Name          accessor      reSIP type      settable
    --------------------------------------------------------
    warn-code      code()        int                yes
    warn-agent     hostname()    Data               yes
    warn-text      text()        Data               yes
  RFC Headers:
    Warning (*)

According to the grammar, each header has a set of acceptable parameters. Some
headers accept no parameters. reSIP makes a simplifying assumption; all headers
can have all parameters. While it is the goal of reSIP that every legal SIP
message be parseable, reSIP does not strictly enforce production of legal
SIP. In practice, correct usage will result in legal SIP, but it is not very
difficult to use reSIP to produce a problematic message. Take home lesson -- the
reSIP programmer must take responsibilty when adding parameters to a header.

A corollary to this simplifying assumption is that the form of a parameter is
independent of the header it appears in. A ttl parameter must always be followed
by an integer even when used in a header that does not specify the syntax for
a ttl parameter. (!dlb! potential compatibility issue)

Parameters, like headers, corresponds to a small set of classes that manage
parsing, accesing, and serializing to text.

(!dlb!: QuotedDataParameter should be super of DataParameter -- currently
allow setting quoted on QuotedDataParameter)

Table of Parameters
===================
RFC name               reSIP access token       reSIP type      
-----------------------------------------------------------
  access-type          p_accessType            DataParameter
  algorithm            p_algorithm             DataParameter
  boundary             p_boundary              DataParameter
  branch               p_branch                BranchParameter
  charset              p_charset               DataParameter
  cnonce               p_cnonce                QuotedDataParameter
  comp                 p_comp                  DataParameter
  d-alg                p_dAlg                  DataParameter
  d-qop                p_dQop                  DataParameter
  d-ver                p_dVer                  QuotedDataParameter
  directory            p_directory             DataParameter
  domain               p_domain                QuotedDataParameter
  duration             p_duration              IntegerParameter
  expiration           p_expiration            IntegerParameter
  expires              p_expires               IntegerParameter
  filename             p_filename              DataParameter
  from-tag             p_fromTag               DataParameter
  handling             p_handling              DataParameter
  id                   p_id                    DataParameter
  lr                   p_lr                    ExistsParameter
  maddr                p_maddr                 DataParameter
  method               p_method                DataParameter
  micalg               p_micalg                DataParameter
  mobility             p_mobility              DataParameter
  mode                 p_mode                  DataParameter
  name                 p_name                  DataParameter
  nc                   p_nc                    DataParameter
  nonce                p_nonce                 QuotedDataParameter
  opaque               p_opaque                QuotedDataParameter
  permission           p_permission            DataParameter
  protocol             p_protocol              DataParameter // should be QuotedDataParameter?
  purpose              p_purpose               DataParameter
  q                    p_q                     FloatParameter
  realm                p_realm                 QuotedDataParameter
  reason               p_reason                DataParameter
  received             p_received              DataParameter
  response             p_response              QuotedDataParameter
  retry-after          p_retryAfter            IntegerParameter
  rport                p_rport                 RportParameter
  server               p_server                DataParameter
  site                 p_site                  DataParameter
  size                 p_size                  DataParameter
  smime-type           p_smimeType             DataParameter
  stale                p_stale                 DataParameter