struct FinderParser Parser of finder messages. More... Definition #include <finder-msg.hh> List of all Methods

Annotated List Files Globals Hierarchy Index

Public Types

• typedef ref_ptr<const FinderParselet> ParsingElement
• typedef list<ParsingElement> PEList

Public Methods

• inline size_t  parse (const string& buf, string::const_iterator& buf_pos) const
• inline size_t  parse_signed (const HMAC& h, const string& buf, string::const_iterator& buf_pos) const
• size_t  parse (const HMAC* h, const string& b, string::const_iterator& bp) const
• bool  add (const ParsingElement& pe)

Public Static Methods

• static ssize_t  peek_header_bytes (const string& header)
• static size_t  max_header_bytes ()
• static size_t  peek_payload_bytes (const string& header)

Protected Methods

• bool  parse_payload (uint32_t src, uint32_t seq, const string& msgname, const string& buf, string::const_iterator& buf_pos) const
• inline bool  parse_signature (const HMAC* h, const string& header, const string& b, string::const_iterator& bp) const

Protected Static Methods

• static bool  parse_header (string::const_iterator& buffer_pos, uint32_t& major, uint32_t& minor, uint32_t& src, uint32_t& seq, uint32_t& payload_bytes, string& msgname)

Protected Members

• PEList _parsers

Detailed Description

Parser of finder messages. Parses common header and passes payload data to registered ParsingElements that invoke user callbacks when packets of given type arrive.

Sub-parsers are added with the add method. add takes a ParsingElement as an argument. These are created by helper functions like hello_notifier, eg:

void hello_handler(const FinderHello& msg) {
	... do something with hello message
}

FinderParser fp;

fp.add(hello_notifier(callback(hello_handler)));

[static]

Attempts to determine if the supplied string looks like a FinderMessage header.

Parameters:

header

candidate finder message header.

Returns: header size if valid, 0 if there is no enough data to determine if it is a valid header. Throws an exception is data does not look like a FinderMessage header.

[static]

Returns: maximum header size (actually size can be certain not a valid header).

[static]

Returns: the size of the payload data.

[const]

Parses message and calls callbacks if message type has a registered notifier.

Parameters:

buf	buffer to be parsed.
buf_pos	starting position of parsing. Updated to point to end of parsing upon return.

[const]

Parses a message using HMAC and calls callbacks if message type has a registered notifier.

Parameters:

h	HMAC instance to be used to check header authentication.
buf	buffer to be parsed.
buf_pos	starting position of parsing. Updated to point to end of parsing upon return.

[const]

Parses a message using HMAC and calls callbacks if message type has a registered notifier.

Parameters:

h	pointer to HMAC to be used to check header authentication.
buf	buffer to be parsed.
buf_pos	starting position of parsing. Updated to point to end of parsing upon return.

Add user callback for a particular message type. Used in conjunction with ParsingElement generating functions (ie notifier and it similarly named brethren).

[protected static]

[protected const]

[protected const]

[protected]