#include <KeepAliveMessage.hxx>

Inheritance diagram for resip::KeepAliveMessage:

Public Member Functions
	RESIP_HeapCount (KeepAliveMessage)

	KeepAliveMessage ()

	KeepAliveMessage (const KeepAliveMessage &message)

virtual Message *	clone () const

KeepAliveMessage &	operator= (const KeepAliveMessage &rhs)

virtual	~KeepAliveMessage ()

virtual EncodeStream &	encode (EncodeStream &str) const
	Generate a string from the SipMessage object.

Public Member Functions inherited from resip::SipMessage
	RESIP_HeapCount (SipMessage)

	SipMessage (const Tuple *receivedTransport=0)

	SipMessage (const SipMessage &message)

SipMessage &	operator= (const SipMessage &rhs)

virtual const Data &	getTransactionId () const
	Returns the transaction id from the branch or if 2543, the computed hash.

const Data &	getRFC2543TransactionId () const
	Calculates an MD5 hash over the Request-URI, To tag (for non-INVITE transactions), From tag, Call-ID, CSeq (including the method), and top Via header.

void	setRFC2543TransactionId (const Data &tid)

virtual	~SipMessage ()

void	parseAllHeaders ()

void	setFromTU ()
	Mark message as internally generated.

void	setFromExternal ()
	Mark message as externally generated.

bool	isExternal () const
	Check if SipMessage is to be treated as it came off the wire.

bool	isFromWire () const
	Check if SipMessage came off the wire.

virtual bool	isClientTransaction () const
	Check if SipMessage is a client transaction.

virtual EncodeStream &	encodeSipFrag (EncodeStream &str) const

EncodeStream &	encodeEmbedded (EncodeStream &str) const

virtual EncodeStream &	encodeBrief (EncodeStream &str) const
	output a brief description to stream

EncodeStream &	encodeSingleHeader (Headers::Type type, EncodeStream &str) const

bool	isRequest () const
	Returns true if message is a request, false otherwise.

bool	isResponse () const
	Returns true if message is a response, false otherwise.

bool	isInvalid () const
	Returns true if message failed to parse, false otherwise.

resip::MethodTypes	method () const
	returns the method type of the message

const Data &	methodStr () const
	Returns a string containing the SIP method for the message.

const resip::Data *	getReason () const
	Returns a string containing the response reason text.

const RequestLine &	header (const RequestLineType &l) const
	Returns the RequestLine. This is only valid for request messages.

RequestLine &	header (const RequestLineType &l)
	Returns the RequestLine. This is only valid for request messages.

const RequestLine &	const_header (const RequestLineType &l) const

const StatusLine &	header (const StatusLineType &l) const
	Returns the StatusLine. This is only valid for response messages.

StatusLine &	header (const StatusLineType &l)
	Returns the StatusLine. This is only valid for response messages.

const StatusLine &	const_header (const StatusLineType &l) const

bool	exists (const HeaderBase &headerType) const
	Returns true if the given header field is present, false otherwise.

bool	empty (const HeaderBase &headerType) const
	Returns true if the header field is present and non-empty, false otherwise.

void	remove (const HeaderBase &headerType)
	Prevents a header field from being present when the message is prepared for sending to a transport.

void	remove (Headers::Type type)

	defineHeader (ContentDisposition, "Content-Disposition", Token, "RFC 3261")

	defineHeader (ContentEncoding, "Content-Encoding", Token, "RFC 3261")

	defineHeader (MIMEVersion, "Mime-Version", Token, "RFC 3261")

	defineHeader (Priority, "Priority", Token, "RFC 3261")

	defineHeader (Event, "Event", Token, "RFC 3265")

	defineHeader (SubscriptionState, "Subscription-State", Token, "RFC 3265")

	defineHeader (SIPETag, "SIP-ETag", Token, "RFC 3903")

	defineHeader (SIPIfMatch, "SIP-If-Match", Token, "RFC 3903")

	defineHeader (ContentId, "Content-ID", Token, "RFC 2045")

	defineMultiHeader (AllowEvents, "Allow-Events", Token, "RFC 3265")

	defineMultiHeader (Identity, "Identity", IdentityCategory, "RFC 8224")

	defineMultiHeader (AcceptEncoding, "Accept-Encoding", Token, "RFC 3261")

	defineMultiHeader (AcceptLanguage, "Accept-Language", Token, "RFC 3261")

	defineMultiHeader (Allow, "Allow", Token, "RFC 3261")

	defineMultiHeader (ContentLanguage, "Content-Language", Token, "RFC 3261")

	defineMultiHeader (ProxyRequire, "Proxy-Require", Token, "RFC 3261")

	defineMultiHeader (Require, "Require", Token, "RFC 3261")

	defineMultiHeader (Supported, "Supported", Token, "RFC 3261")

	defineMultiHeader (Unsupported, "Unsupported", Token, "RFC 3261")

	defineMultiHeader (SecurityClient, "Security-Client", Token, "RFC 3329")

	defineMultiHeader (SecurityServer, "Security-Server", Token, "RFC 3329")

	defineMultiHeader (SecurityVerify, "Security-Verify", Token, "RFC 3329")

	defineMultiHeader (RequestDisposition, "Request-Disposition", Token, "RFC 3841")

	defineMultiHeader (Reason, "Reason", Token, "RFC 3326")

	defineMultiHeader (Privacy, "Privacy", PrivacyCategory, "RFC 3323")

	defineMultiHeader (PMediaAuthorization, "P-Media-Authorization", Token, "RFC 3313")

	defineHeader (ReferSub, "Refer-Sub", Token, "RFC 4488")

	defineHeader (AnswerMode, "Answer-Mode", Token, "draft-ietf-answermode-04")

	defineHeader (PrivAnswerMode, "Priv-Answer-Mode", Token, "draft-ietf-answermode-04")

	defineMultiHeader (Accept, "Accept", Mime, "RFC 3261")

	defineHeader (ContentType, "Content-Type", Mime, "RFC 3261")

	defineMultiHeader (CallInfo, "Call-Info", GenericUri, "RFC 3261")

	defineMultiHeader (AlertInfo, "Alert-Info", GenericUri, "RFC 3261")

	defineMultiHeader (ErrorInfo, "Error-Info", GenericUri, "RFC 3261")

	defineHeader (IdentityInfo, "Identity-Info", GenericUri, "RFC 4474")

	defineMultiHeader (RecordRoute, "Record-Route", NameAddr, "RFC 3261")

	defineMultiHeader (Route, "Route", NameAddr, "RFC 3261")

	defineMultiHeader (Contact, "Contact", NameAddr, "RFC 3261")

	defineHeader (From, "From", NameAddr, "RFC 3261")

	defineHeader (To, "To", NameAddr, "RFC 3261")

	defineHeader (ReplyTo, "Reply-To", NameAddr, "RFC 3261")

	defineHeader (ReferTo, "Refer-To", NameAddr, "RFC 3515")

	defineHeader (ReferredBy, "Referred-By", NameAddr, "RFC 3892")

	defineMultiHeader (Path, "Path", NameAddr, "RFC 3327")

	defineMultiHeader (AcceptContact, "Accept-Contact", NameAddr, "RFC 3841")

	defineMultiHeader (RejectContact, "Reject-Contact", NameAddr, "RFC 3841")

	defineMultiHeader (PAssertedIdentity, "P-Asserted-Identity", NameAddr, "RFC 3325")

	defineMultiHeader (PPreferredIdentity, "P-Preferred-Identity", NameAddr, "RFC 3325")

	defineHeader (PCalledPartyId, "P-Called-Party-ID", NameAddr, "RFC 3455")

	defineMultiHeader (PAssociatedUri, "P-Associated-URI", NameAddr, "RFC 3455")

	defineMultiHeader (ServiceRoute, "Service-Route", NameAddr, "RFC 3608")

	defineMultiHeader (RemotePartyId, "Remote-Party-ID", NameAddr, "draft-ietf-sip-privacy-04")

	defineMultiHeader (HistoryInfo, "History-Info", NameAddr, "RFC 4244")

	defineMultiHeader (Diversion, "Diversion", NameAddr, "RFC 5806")

	defineHeader (ContentTransferEncoding, "Content-Transfer-Encoding", StringCategory, "RFC 1521")

	defineHeader (Organization, "Organization", StringCategory, "RFC 3261")

	defineHeader (SecWebSocketKey, "Sec-WebSocket-Key", StringCategory, "RFC 6455")

	defineHeader (SecWebSocketKey1, "Sec-WebSocket-Key1", StringCategory, "draft-hixie- thewebsocketprotocol-76")

	defineHeader (SecWebSocketKey2, "Sec-WebSocket-Key2", StringCategory, "draft-hixie- thewebsocketprotocol-76")

	defineHeader (Origin, "Origin", StringCategory, "draft-hixie- thewebsocketprotocol-76")

	defineHeader (Host, "Host", StringCategory, "draft-hixie- thewebsocketprotocol-76")

	defineHeader (SecWebSocketAccept, "Sec-WebSocket-Accept", StringCategory, "RFC 6455")

	defineMultiHeader (Cookie, "Cookie", StringCategory, "RFC 6265")

	defineHeader (Server, "Server", StringCategory, "RFC 3261")

	defineHeader (Subject, "Subject", StringCategory, "RFC 3261")

	defineHeader (UserAgent, "User-Agent", StringCategory, "RFC 3261")

	defineHeader (Timestamp, "Timestamp", StringCategory, "RFC 3261")

	defineHeader (ContentLength, "Content-Length", UInt32Category, "RFC 3261")

	defineHeader (MaxForwards, "Max-Forwards", UInt32Category, "RFC 3261")

	defineHeader (MinExpires, "Min-Expires", UInt32Category, "RFC 3261")

	defineHeader (RSeq, "RSeq", UInt32Category, "RFC 3261")

	defineHeader (RetryAfter, "Retry-After", UInt32Category, "RFC 3261")

	defineHeader (FlowTimer, "Flow-Timer", UInt32Category, "RFC 5626")

	defineHeader (Expires, "Expires", ExpiresCategory, "RFC 3261")

	defineHeader (SessionExpires, "Session-Expires", ExpiresCategory, "RFC 4028")

	defineHeader (MinSE, "Min-SE", ExpiresCategory, "RFC 4028")

	defineHeader (CallID, "Call-ID", CallID, "RFC 3261")

	defineHeader (Replaces, "Replaces", CallID, "RFC 3891")

	defineHeader (InReplyTo, "In-Reply-To", CallID, "RFC 3261")

	defineHeader (Join, "Join", CallId, "RFC 3911")

	defineHeader (TargetDialog, "Target-Dialog", CallId, "RFC 4538")

	defineHeader (AuthenticationInfo, "Authentication-Info", Auth, "RFC 3261")

	defineMultiHeader (Authorization, "Authorization", Auth, "RFC 3261")

	defineMultiHeader (ProxyAuthenticate, "Proxy-Authenticate", Auth, "RFC 3261")

	defineMultiHeader (ProxyAuthorization, "Proxy-Authorization", Auth, "RFC 3261")

	defineMultiHeader (WWWAuthenticate, "Www-Authenticate", Auth, "RFC 3261")

	defineHeader (CSeq, "CSeq", CSeqCategory, "RFC 3261")

	defineHeader (Date, "Date", DateCategory, "RFC 3261")

	defineMultiHeader (Warning, "Warning", WarningCategory, "RFC 3261")

	defineMultiHeader (Via, "Via", Via, "RFC 3261")

	defineHeader (RAck, "RAck", RAckCategory, "RFC 3262")

	defineMultiHeader (PAccessNetworkInfo, "P-Access-Network-Info", Token, "RFC 7315")

	defineHeader (PChargingVector, "P-Charging-Vector", Token, "RFC 3455")

	defineHeader (PChargingFunctionAddresses, "P-Charging-Function-Addresses", Token, "RFC 3455")

	defineMultiHeader (PVisitedNetworkID, "P-Visited-Network-ID", TokenOrQuotedStringCategory, "RFC 3455")

	defineMultiHeader (UserToUser, "User-to-User", TokenOrQuotedStringCategory, "draft-ietf-cuss-sip-uui-17")

const StringCategories &	header (const ExtensionHeader &symbol) const
	unknown header interface

StringCategories &	header (const ExtensionHeader &symbol)
	Retrieves extension header values.

bool	exists (const ExtensionHeader &symbol) const

void	remove (const ExtensionHeader &symbol)

const HeaderFieldValueList *	getRawHeader (Headers::Type headerType) const
	typeless header interface

void	setRawHeader (const HeaderFieldValueList *hfvs, Headers::Type headerType)

const KnownHeaders &	getRawHeaders () const noexcept

const UnknownHeaders &	getRawUnknownHeaders () const noexcept

const HeaderFieldValue &	getRawBody () const noexcept
	Return the raw body string (if it exists).

void	setRawBody (const HeaderFieldValue &body)
	Remove any existing body/contents, and (if non-empty) set the body to {body}.

Contents *	getContents () const
	Retrieves the body of a SIP message.

std::unique_ptr< Contents >	releaseContents ()
	Removes the contents from the message.

void	setContents (const Contents *contents)
	Set the contents of the message.

void	setContents (std::unique_ptr< Contents > contents)

void	setStartLine (const char *start, uint32_t len)

void	setBody (const char *start, uint32_t len)

void	addHeader (Headers::Type header, const char headerName, uint32_t headerNameLen, const char value, uint32_t valuelen)
	Add HeaderFieldValue given enum, header name and value.

const Tuple &	getReceivedTransportTuple () const

void	setReceivedTransportTuple (const Tuple &transportTuple)
	Set Tuple for transport from whence this message came.

void	setSource (const Tuple &tuple)

const Tuple &	getSource () const
	Returns the source tuple that the message was received from only makes sense for messages received from the wire.

void	setDestination (const Tuple &tuple)
	Used by the stateless interface to specify where to send a request/response.

Tuple &	getDestination ()

void	addBuffer (char *buf)

uint64_t	getCreatedTimeMicroSec () const

void	setForceTarget (const Uri &uri)
	deal with a notion of an "out-of-band" forced target for SIP routing

void	clearForceTarget ()

const Uri &	getForceTarget () const

bool	hasForceTarget () const

const Data &	getTlsDomain () const

void	setTlsDomain (const Data &domain)

const std::shared_ptr< const ConnectionInfo > &	getConnectionInfo () const noexcept
	TLS and WebSocket details of the connection this message was received on, shared by every message received on that connection.

void	setConnectionInfo (std::shared_ptr< const ConnectionInfo > connectionInfo) noexcept

const std::list< Data > &	getTlsPeerNames () const

const Data &	getTlsSni () const
	SNI (TLS server_name) the peer sent in its ClientHello.

const CookieList &	getWsCookies () const

std::shared_ptr< WsCookieContext >	getWsCookieContext () const noexcept

void	setTlsPeerNames (const std::list< Data > &tlsPeerNames)

void	setWsCookies (const CookieList &wsCookies)

void	setWsCookieContext (std::shared_ptr< WsCookieContext > wsCookieContext)

Data	getCanonicalIdentityString () const

SipMessage &	mergeUri (const Uri &source)

void	setSecurityAttributes (std::unique_ptr< SecurityAttributes >) noexcept

const SecurityAttributes *	getSecurityAttributes () const noexcept

void	addOutboundDecorator (std::unique_ptr< MessageDecorator > md)
	Call a MessageDecorator to process the message before it is sent to the transport.

void	clearOutboundDecorators ()

void	callOutboundDecorators (const Tuple &src, const Tuple &dest, const Data &sigcompId)

void	rollbackOutboundDecorators ()

void	copyOutboundDecoratorsToStackCancel (SipMessage &cancel)

void	copyOutboundDecoratorsToStackFailureAck (SipMessage &ack)

Public Member Functions inherited from resip::TransactionMessage
	RESIP_HeapCount (TransactionMessage)

Public Member Functions inherited from resip::Message
	Message ()

virtual	~Message ()

virtual Brief	brief () const
	return a facet for brief encoding of message

Additional Inherited Members
Public Types inherited from resip::SipMessage
typedef std::list< std::pair< Data, HeaderFieldValueList * >, StlPoolAllocator< std::pair< Data, HeaderFieldValueList * >, PoolBase > >	UnknownHeaders

Static Public Member Functions inherited from resip::SipMessage
static SipMessage *	make (const Data &buffer, bool isExternal=false)
	Construct a SipMessage object from a string containing a SIP request or response.

Public Attributes inherited from resip::SipMessage
bool	mIsDecorated

bool	mIsBadAck200

Static Public Attributes inherited from resip::SipMessage
static bool	checkContentLength =true

Protected Member Functions inherited from resip::SipMessage
void	clear (bool leaveResponseStuff=false)

void	freeMem (bool leaveResponseStuff=false)

void	clearHeaders ()

void	init (const SipMessage &rhs)

Protected Member Functions inherited from resip::Message
bool	hasTransactionUser () const

void	setTransactionUser (TransactionUser *t)

TransactionUser *	getTransactionUser ()

Protected Attributes inherited from resip::Message
TransactionUser *	mTu

Detailed Description

Definition at line 8 of file KeepAliveMessage.hxx.

Constructor & Destructor Documentation

◆ KeepAliveMessage() [1/2]

KeepAliveMessage::KeepAliveMessage ( )

Definition at line 6 of file KeepAliveMessage.cxx.

◆ KeepAliveMessage() [2/2]

KeepAliveMessage::KeepAliveMessage ( const KeepAliveMessage & message )

Definition at line 10 of file KeepAliveMessage.cxx.

◆ ~KeepAliveMessage()

KeepAliveMessage::~KeepAliveMessage ( )

virtual

Definition at line 21 of file KeepAliveMessage.cxx.

Member Function Documentation

◆ clone()

Message * KeepAliveMessage::clone ( ) const

virtual

Todo:: .dlb. sure would be nice to have overloaded return value here..

Reimplemented from resip::SipMessage.

Definition at line 37 of file KeepAliveMessage.cxx.

◆ encode()

EncodeStream & KeepAliveMessage::encode ( EncodeStream & str ) const

virtual

Generate a string from the SipMessage object.

Returns: string representation of a SIP message.

Reimplemented from resip::SipMessage.

Definition at line 43 of file KeepAliveMessage.cxx.

◆ operator=()

KeepAliveMessage & KeepAliveMessage::operator= ( const KeepAliveMessage & rhs )

Definition at line 27 of file KeepAliveMessage.cxx.

◆ RESIP_HeapCount()

resip::KeepAliveMessage::RESIP_HeapCount ( KeepAliveMessage )

The documentation for this class was generated from the following files:

resip/stack/KeepAliveMessage.hxx
resip/stack/KeepAliveMessage.cxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KeepAliveMessage() [1/2]

◆ KeepAliveMessage() [2/2]

◆ ~KeepAliveMessage()

Member Function Documentation

◆ clone()

◆ encode()

◆ operator=()

◆ RESIP_HeapCount()