SIP Headers - Sofia-SIP Library

SIP Headers ; Modules ; SIP Header X - Conventions ; For a SIP header X, there are types, functions, macros and global data declared in  ... Main Page Related Pages Modules Data Structures Files SIPheadersandotherSIPmessageelements. More... Modules  SIPHeaderX-Conventions  ForaSIPheaderX,therearetypes,functions,macrosandglobaldatadeclaredinandasfollows: sip_X_tisthestructureusedtostoreparsedheader, SIP_X_INIT()initializesastaticinstanceofsip_X_t, sip_X_init()initializesadynamicinstanceofsip_X_t, sip_is_X()testsifheaderobjectisinstanceofheaderX, sip_X_make()createsaheaderXobjectbydecodinggivenstring, sip_X_format()createsaheaderXobjectbydecodinggivenprintf()list, sip_X_dup()duplicates(deeplycopies)theheaderX, sip_X_copy()copiestheheaderX, msg_hclass_tsip_X_class[]containstheheaderclassforheaderX.  RequestLine  TherequestlineisfirstlineinaSIPrequestmessage.  StatusLine  Thestatuslineisfirstlineinaresponsemessage.  MessageBody  Thepayloadstructurecontainstheoptionalmessagebody.  SeparatorLine  Anemptylineseparatesmessageheadersfromthemessagebody(payload).  UnknownHeaders  Theunknownheadersarehandledwithsip_unknown_tstructure.  ErroneousHeaders  Theerroneousheadersarestoredinsip_error_tstructure.  Call-IDHeader  TheCall-IDheaderuniquelyidentifiesaparticularinvitationorallregistrationsofaparticularclient.  CSeqHeader  TheCSeqheader(commandsequence)uniquelyidentifiestransactionswithinadialog.  ContactHeader  TheContactheadercontainalistofURLsusedtoredirectfuturerequests.  Content-LengthHeader  TheContent-Lengthheaderindicatesthesizeofthemessage-bodyindecimalnumberofoctets.  DateHeader  TheDateheaderfieldreflectsthetimewhentherequestorresponsewasfirstsent.  ExpiresHeader  TheExpiresheaderfieldgivesthedateandtimeafterwhichthemessagecontentexpires.  FromHeader  TheFromheaderindicatestheinitiatoroftherequest.  Max-ForwardsHeader  TheMax-Forwardsheaderisusedtolimitthenumberofproxiesorgatewaysthatcanforwardtherequest.  Min-ExpiresHeader  TheMin-Expiresheaderisusedtolimitthenumberofproxiesorgatewaysthatcanforwardtherequest.  Retry-AfterHeader  TheRetry-Afterresponse-headerfieldRFC3261section20.33canbeusedtoindicatehowlongtheserviceisexpectedtobeunavailableorwhenthecalledpartyanticipatesbeingavailableagain.  RouteHeader  TheRouteheadersisusedtostoretheroutesetofatransaction.  Record-RouteHeader  TheRecord-Routeheadersareusedtoestablisharoutefortransactionsbelongingtoasession.  ToHeader  TheToheaderfieldspecifiesthe"logical"recipientoftherequest.  ViaHeader  TheViaheaderindicatesthepathtakenbytherequestsofar.  Request-DispositionHeader  TheRequest-DispositionheadersyntaxisdefinedinRFC3841section10asfollows:  Accept-ContactHeader  TheAccept-ContactsyntaxisdefinedinRFC3841section10asfollows:  Reject-ContactHeader  TheReject-ContactsyntaxisdefinedinRFC3841section10asfollows:  EventHeader  TheEventheaderisusedtoindicatethewhicheventorclassofeventsthemessagecontainsorsubscribes.  Allow-EventsHeader  TheAllow-Eventsheaderisusedtoindicatewhicheventsorclassesofeventsthenotifiersupports.  Subscription-StateHeader  TheSubscription-Stateheaderisusedtoindicateinwhichstateasubscriptionis.  Call-InfoHeader  TheCall-Infoheaderprovidesadditionalinformationaboutthecallerorcallee.  Error-InfoHeader  TheError-Infoheaderprovidesapointertoadditionalinformationabouttheerrorstatusresponse.  Alert-InfoHeader  WhenpresentinanINVITErequest,theAlert-InfoheaderfieldspecifiesanalternativeringtonetotheUAS.  Reply-ToHeader  TheReply-ToheaderfieldcontainsalogicalreturnURIthatmaybedifferentfromtheFromheaderfield.  In-Reply-ToHeader  TheIn-Reply-TorequestheaderfieldenumeratestheCall-IDsthatthiscallreferencesorreturns.  OrganizationHeader  TheOrganizationheaderfieldconveysthenameoftheorganizationtowhichtheentityissuingtherequestorresponsebelongs.  PriorityHeader  ThePriorityrequest-headerfieldindicatestheurgencyoftherequestasperceivedbytheclient.  ServerHeader  TheServerresponse-headerfieldcontainsinformationaboutthesoftwareusedbytheuseragentservertohandletherequest.  SubjectHeader  TheSubjectheaderprovidesasummaryorindicatesthenatureoftherequest.  TimestampHeader  TheTimestampheaderdescribeswhentheclientsenttherequesttotheserver,anditisusedbytheclienttoadjustitsretransmissionintervals.  User-AgentHeader  TheUser-Agentheadercontainsinformationabouttheclientuseragentoriginatingtherequest.  SIP-ETagHeader  TheSIP-ETagheaderfieldidentifiesthepublishedeventstate.  SIP-If-MatchHeader  TheSIP-If-Matchheaderfieldidentifiesthespecificentityofeventstatethattherequestisrefreshing,modifyingorremoving.  Suppress-Body-If-MatchHeader  TheSuppress-Body-If-MatchheaderfieldidentifiesaSIPeventcontentalreadyknownbythewatcher.  Suppress-Notify-If-MatchHeader  TheSuppress-Notify-If-MatchheaderisusedtosuppresssuperfluousNOTIFYtransactions.  Remote-Party-IDHeader  ThesyntaxoftheRemote-Party-IDheaderisdescribedasfollows:  P-Asserted-IdentityHeader  TheP-Asserted-IdentityheaderisusedusedamongtrustedSIPentities(typicallyintermediaries)tocarrytheidentityoftheusersendingaSIPmessageasitwasverifiedbyauthentication.  P-Preferred-IdentityHeader  TheP-Preferred-IdentityheaderisusedusedamongtrustedSIPentities(typicallyintermediaries)tocarrytheidentityoftheusersendingaSIPmessageasitwasverifiedbyauthentication.  AllowHeader  TheAllowheaderliststhesetofmethodssupportedbytheuseragentgeneratingthemessage.  Proxy-RequireHeader  TheProxy-Requireheaderisusedtoindicateproxy-sensitivefeaturesthatMUSTbesupportedbytheproxy.  RequireHeader  TheRequireheaderisusedbyclientstotelluseragentserversaboutoptionsthattheclientexpectstheservertosupportinordertoproperlyprocesstherequest.  SupportedHeader  TheSupportedheaderenumeratesallthecapabilitiesoftheclientorserver.  UnsupportedHeader  TheUnsupportedheaderliststhefeaturesnotsupportedbytheserver.  PathHeader  ThePathheaderfieldisaSIPextensionheaderfield(RFC3327)withsyntaxverysimilartotheRecord-Routeheaderfield.  Service-RouteHeader  The"Service-Route"isaSIPextensionheaderfield(RFC3608),whichcancontainaroutevectorthatwilldirectrequeststhroughaspecificsequenceofproxies.  AcceptHeader  TheAcceptrequest-headerfieldcanbeusedtospecifycertainmediatypeswhichareacceptablefortheresponse.  Accept-EncodingHeader  TheAccept-EncodingheaderissimilartoAccept,butrestrictsthecontent-codingsthatareacceptableintheresponse.  Accept-LanguageHeader  TheAccept-Languageheadercanbeusedtoallowtheclienttoindicatetotheserverinwhichlanguageitwouldprefertoreceivereasonphrases,sessiondescriptionsorstatusresponsescarriedasmessagebodies.  Content-DispositionHeader  TheContent-Dispositionheaderfielddescribeshowthemessagebodyor,inthecaseofmultipartmessages,amessagebodypartistobeinterpretedbytheUACorUAS.  Content-EncodingHeader  TheContent-Encodingheaderindicateswhatadditionalcontentcodingshavebeenappliedtotheentity-body.  Content-LanguageHeader  TheContent-LanguageheaderRFC2616section14.12describesthenaturallanguage(s)oftheintendedaudiencefortheenclosedentity.  Content-TypeHeader  TheContent-Typeheaderindicatesthemediatypeofthemessage-bodysenttotherecipient.  MIME-VersionHeader  MIME-VersionheaderindicateswhatversionoftheMIMEprotocolwasusedtoconstructthemessage.  WarningHeader  TheWarningresponse-headerfieldisusedtocarryadditionalinformationaboutthestatusofaresponse.  RAckHeader  TheRAckheaderindicatesthesequencenumberoftheprovisionalresponsewhichisbeingacknowledged.  RSeqHeader  TheRSeqheaderidentifiesprovisionalresponseswithinatransaction.  ReasonHeader  TheReasonheaderisusedtoindicatewhyaSIPrequestwasissuedorwhyaprovisionalresponsewassent.  Refer-ToHeader  TheRefer-ToheaderprovidesaURItoreference.  Referred-ByHeader  TheReferred-Byheaderconveystheidentityoftheoriginalreferrertothereferred-toparty.  ReplacesHeader  TheReplacesheaderindicatesthatasingledialogidentifiedbytheheaderfieldistobeshutdownandlogicallyreplacedbytheincomingINVITEinwhichitiscontained.  Refer-SubHeader  SIPheaderfieldRefer-SubismeaningfulandMAYbeusedwithaREFERrequestandthecorresponding2XXresponseonly.  AuthorizationHeader  TheAuthorizationheaderconsistsofcredentialscontainingtheauthenticationinformationoftheuseragentfortherealmoftheresourcebeingrequested.  Proxy-AuthenticateHeader  TheProxy-Authenticateheaderconsistsofachallengethatindicatestheauthenticationschemeandparametersapplicabletotheproxy.  Proxy-AuthorizationHeader  TheProxy-Authorizationheaderconsistsofcredentialscontainingtheauthenticationinformationoftheuseragentfortheproxyand/orrealmoftheresourcebeingrequested.  WWW-AuthenticateHeader  TheWWW-Authenticateheaderconsistsofatleastonechallengethatindicatestheauthenticationscheme(s)andparametersapplicabletotheRequest-URI.  Authentication-InfoHeader  TheAuthentication-Infoheadercontainseitheranext-nonceusedbynextrequestand/orauthenticationfromserverusedinmutualauthentication.  Proxy-Authentication-InfoHeader  TheProxy-Authentication-Infoheadercontainseitheranext-nonceusedbynextrequestand/orauthenticationfromproxyusedinmutualauthentication.  Security-ClientHeader  TheSecurity-ClientheaderisdefinedbyRFC3329,"SecurityMechanism AgreementfortheSessionInitiationProtocol(SIP)".  Security-ServerHeader  TheSecurity-ServerheaderisdefinedbyRFC3329,"SecurityMechanism AgreementfortheSessionInitiationProtocol(SIP)".  Security-VerifyHeader  TheSecurity-VerifyheaderisdefinedbyRFC3329,"SecurityMechanism AgreementfortheSessionInitiationProtocol(SIP)".  PrivacyHeader  ThePrivacyheaderisusedbyUser-Agenttorequestprivacyservicesfromthenetwork.  Session-ExpiresHeader  TheSession-Expiresheaderisusedtoconveythelifetimeofthesession.  Min-SEHeader  TheMin-SEheaderisusedtoindicatetheminimumvalueforthesessioninterval. DetailedDescription SIPheadersandotherSIPmessageelements. ForeachSIPheaderrecognizedbytheSIPmodule,thereisaheaderstructurecontainingtheparsedvalue.Theheaderstructurenameisgeneratedfromtheheadernamebylowercasingthename,replacingthenon-alphanumericcharacters(usuallyjustminus"-")withunderscore"_"characters,andthenaddingprefixsip_andsuffix_t.Forinstance,thecontentsofheader"MIME-Version"isstoredinastructurecalledsip_mime_version_t.  All DataStructures Files Functions Variables Typedefs Enumerations Enumerator Defines Sofia-SIP1.12.11- Copyright(C)2006NokiaCorporation.Allrightsreserved. LicensedunderthetermsoftheGNULesserGeneralPublicLicense.