class ClickSocketReader


 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods


Detailed Description

 ClickSocketReader (ClickSocket& cs)

ClickSocketReader

 ~ClickSocketReader ()

~ClickSocketReader

[virtual]

int  receive_kernel_click_data (ClickSocket& cs, uint32_t seqno, string& error_msg)

receive_kernel_click_data

Force the reader to receive kernel-level Click data from the specified Click socket.

Parameters:

csthe Click socket to receive the data from.
seqnothe sequence number of the data to receive.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  receive_user_click_data (ClickSocket& cs, uint32_t seqno, string& error_msg)

receive_user_click_data

Force the reader to receive user-level Click data from the specified Click socket.

Parameters:

csthe Click socket to receive the data from.
seqnothe sequence number of the data to receive.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

const string&  buffer_str ()

buffer_str

[const]

Return the buffer as a string with the data that was received.

Returns: a C-style string with the data that was received.

const size_t  buffer_size ()

buffer_size

[const]

Get the size of the buffer with the data that was received.

Returns: the size of the buffer with the data that was received.

void  clsock_data (const uint8_t* data, size_t nbytes)

clsock_data

[virtual]

Receive data from the Click socket.

Note that this method is called asynchronously when the Click socket has data to receive, therefore it should never be called directly by anything else except the Click socket facility itself.

Parameters:

datathe buffer with the received data.
nbytesthe number of bytes in the data buffer.

Reimplemented from ClickSocketObserver.


Generated by: pavlin on possum.icir.org on Wed Aug 2 15:36:19 2006, using kdoc $.