class Xrl

XORP IPC request. More...

 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods


Detailed Description

XORP IPC request.

 Xrl (const string& protocol, const string& protocol_target, const string& command, const XrlArgs& args)

Xrl

Construct an Xrl.

 Xrl (const string& target, const string& command, const XrlArgs& args)

Xrl

Construct an Xrl (with implicit finder protocol).

 Xrl (const string& protocol, const string& protocol_target, const string& command)

Xrl

Construct an Xrl that does not have an argument list.

 Xrl (const string& target, const string& command)

Xrl

Construct an Xrl that does not have an argument list.

 Xrl (const char* xrl_c_str)
throw (InvalidString)

Xrl

Construct an Xrl object from the string representation of Xrl.

 Xrl ()

Xrl

 ~Xrl ()

~Xrl

string  str ()

str

[const]

Render Xrl as a string

const string&  protocol ()

protocol

[const]

Returns: the protocol associated with XRL.

const string&  target ()

target

[const]

Returns: the name of the XRL target entity.

string  string_no_args ()

string_no_args

[const]

Returns: string representation of Xrl without arguments.

const string&  command ()

command

[const]

Returns: the name of the command

XrlArgs&  args ()

args

Retrieve list of arguments associated with the XRL.

const XrlArgs&  args ()

args

[const]

Retrieve list of arguments associated with the XRL.

bool  operator== (const Xrl& x)

operator==

[const]

Test the equivalence of two XRL's.

Returns: true if the XRL's are equivalent.

bool  is_resolved ()

is_resolved

[const]

Returns: true if Xrl is resolved, ie protocol == finder.

size_t  packed_bytes ()

packed_bytes

[const]

Get number of bytes needed to pack XRL into a serialized byte form.

size_t  pack (uint8_t* buffer, size_t buffer_bytes)

pack

[const]

Pack XRL into a byte array. The size of the byte array should be larger or equal to the value returned by packed_bytes().

Parameters:

bufferbuffer to receive data.
buffer_bytessize of buffer.

Returns: size of packed data on success, 0 on failure.

size_t  unpack (const uint8_t* buffer, size_t buffer_bytes)

unpack

Unpack XRL from serialized byte array.

Parameters:

bufferto read data from.
buffer_bytessize of buffer. The size should exactly match number of bytes of packed data, ie packed_bytes() value used when packing.

Returns: number of bytes turned into atoms on success, 0 on failure.


Generated by: bms on anglepoise.lon.incunabulum.net on Wed Jul 23 10:05:36 2008, using kdoc 2.0a54+XORP.