libxipc Globals


Annotated List
Files
Globals
Hierarchy
Index

finder-client.hh

finder-ipc.hh

finder-msg.hh

hmac_md5.h

sockutil.hh

xrl.hh

xrlatom-encoding.hh

xrlatom.hh

xrlcmdmap.hh

xrlerror.hh

xrlpf-stcp-ph.hh

Global member Documentation

enum FinderClientError { FC_OKAY, FC_LOOKUP_FAILED, FC_ADD_FAILED, FC_REMOVE_FAILED, FC_NO_SERVER }

FinderClientError

#include <finder-client.hh>

typedef void  (*FinderClientCallback) (FinderClientError code, const char* name, const char* value, void* thunk)

(*FinderClientCallback)

#include <finder-client.hh>

enum FinderMessageType { HELLO = 0, BYE = 1, REGISTER = 2, UNREGISTER = 3, NOTIFY = 4, LOCATE = 5, ERROR = 6 }

FinderMessageType

#include <finder-ipc.hh>

typedef void  (*ServiceCreationHook) (FinderTCPIPCService* created, void* thunk)

(*ServiceCreationHook)

#include <finder-ipc.hh>

inline FinderParser::ParsingElement  hello_notifier (const FinderHelloParser::Callback& cb)

hello_notifier

#include <finder-msg.hh>

ParsingElement generating function to hook user callbacks when HELLO messages are received. Used in conjunction with FinderParser::add.

inline FinderParser::ParsingElement  bye_notifier (const FinderByeParser::Callback& cb)

bye_notifier

#include <finder-msg.hh>

ParsingElement generating function to hook user callbacks when BYE messages are received. Used in conjunction with FinderParser::add.

inline FinderParser::ParsingElement  ack_notifier (const FinderAckParser::Callback& cb)

ack_notifier

#include <finder-msg.hh>

ParsingElement generating function to hook user callbacks when ACK messages are received. Used in conjunction with FinderParser::add.

inline FinderParser::ParsingElement  associate_notifier (const FinderAssociateParser::Callback& cb)

associate_notifier

#include <finder-msg.hh>

ParsingElement generating function to hook user callbacks when ASSOCIATE messages are received. Used in conjunction with FinderParser::add.

inline FinderParser::ParsingElement  question_notifier (const FinderQuestionParser::Callback& cb)

question_notifier

#include <finder-msg.hh>

ParsingElement generating function to hook user callbacks when QUESTION messages are received. Used in conjunction with FinderParser::add.

inline FinderParser::ParsingElement  answer_notifier (const FinderAnswerParser::Callback& cb)

answer_notifier

#include <finder-msg.hh>

ParsingElement generating function to hook user callbacks when ANSWER messages are received. Used in conjunction with FinderParser::add.

void  hmac_md5 (const unsigned char *data, int data_len, const unsigned char *key, int key_len, unsigned char digest[16])

hmac_md5

#include <hmac_md5.h>

enum IPSocketType { UDP = IPPROTO_UDP, TCP = IPPROTO_TCP }

IPSocketType

#include <sockutil.hh>

int  create_connected_ip_socket (IPSocketType t, const string& addr_slash_port)

create_connected_ip_socket

#include <sockutil.hh>

Returns: fd of socket or -1 if unsuccessful.

int  create_connected_ip_socket (IPSocketType t, const string& addr, uint16_t port)

create_connected_ip_socket

#include <sockutil.hh>

Returns: fd of socket or -1 if unsuccessful.

int  create_listening_ip_socket (IPSocketType ist, uint16_t port = 0)

create_listening_ip_socket

#include <sockutil.hh>

Returns: fd of socket or -1 if unsuccessful.

void  close_socket (int fd)

close_socket

#include <sockutil.hh>

Release state associated with socket and close it.

bool  get_local_socket_details (int fd, string& addr, uint16_t& port)

get_local_socket_details

#include <sockutil.hh>

Returns: true if addr and port were filled in.

bool  get_remote_socket_details (int fd, string& addr, uint16_t& port)

get_remote_socket_details

#include <sockutil.hh>

Returns: true if addr and port were filled in.

int  get_socket_sndbuf_bytes (int fd)

get_socket_sndbuf_bytes

#include <sockutil.hh>

Get socket send buffer size.

Returns: size or -1 if size could not be read.

int  get_socket_rcvbuf_bytes (int fd)

get_socket_rcvbuf_bytes

#include <sockutil.hh>

Get socket receive buffer size.

Returns: size or -1 if size could not be read.

int  set_socket_sndbuf_bytes (int fd, uint32_t bytes)

set_socket_sndbuf_bytes

#include <sockutil.hh>

Set socket send buffer size.

Returns: size or -1 if size could not be set.

int  set_socket_rcvbuf_bytes (int fd, uint32_t bytes)

set_socket_rcvbuf_bytes

#include <sockutil.hh>

Set socket receive buffer size.

Returns: size or -1 if size could not be set.

string  address_slash_port (const string& addr, uint16_t port)

address_slash_port

#include <sockutil.hh>

Returns: address slash port

bool  split_address_slash_port (const string& address_slash_port, string& address, uint16_t& port)

split_address_slash_port

#include <sockutil.hh>

Returns: true if address_slash_port was split successfully.

bool  address_lookup (const string& addr, in_addr& ia)

address_lookup

#include <sockutil.hh>

Parameters:
addressto be resolved.
networkaddress.

Returns: true if address resolves.

uint32_t  if_count ()

if_count

#include <sockutil.hh>

Returns: number of network interfaces reported by OS.

bool  if_probe (uint32_t index, string& name, in_addr& addr, uint16_t& flags)

if_probe

#include <sockutil.hh>

Query interface parameters.

Parameters:
indexof interface [1..if_count()].
referenceto string to take interface's name.
referenceto in_addr to take interface's IPv4 address.
referenceto uint16_t to take interface's flags.

Returns: true on success, false on failure.

bool  if_set_preferred (in_addr addr)

if_set_preferred

#include <sockutil.hh>

Set preferred interface for IPC communication.

Returns: true on success, false if addr is not a valid interface address or is marked as down.

in_addr  if_get_preferred ()

if_get_preferred

#include <sockutil.hh>

Get preferred interface for IPC communication. If not set by if_set_preferred, it is the first valid non-loopback interface. Otherwise it is the loopback interface.

typedef Xrl XrlTemplate

XrlTemplate

#include <xrl.hh>

string  xrlatom_encode_value (const char* val, size_t val_bytes)

xrlatom_encode_value

#include <xrlatom-encoding.hh>

Encode the string representation of an XrlAtom value into a value suitable for integrating into a spaceless Xrl representation. This is essentially URL encoding though a reduced subset of non-alphanumeric characters are escaped, ie only those that would otherwise interfere with Xrl parsing.

inline string  xrlatom_encode_value (const string& val)

xrlatom_encode_value

#include <xrlatom-encoding.hh>

Encode the string representation of an XrlAtom value into a value suitable for integrating into a spaceless Xrl representation. This is essentially URL encoding though a reduced subset of non-alphanumeric characters are escaped, ie only those that would otherwise interfere with Xrl parsing.

inline string  xrlatom_encode_value (const vector<uint8_t>& v)

xrlatom_encode_value

#include <xrlatom-encoding.hh>

Encode string representation of a binary data type XrlAtom value into a value suitable for integrating into a spaceless Xrl representation.

ssize_t  xrlatom_decode_value (const char* in, size_t in_bytes, string& out)

xrlatom_decode_value

#include <xrlatom-encoding.hh>

Decode escaped XrlAtom representation.

Returns: -1 on success, or the index of the character causing the decode failure in the string "in" when an.

ssize_t  xrlatom_decode_value (const char* in, size_t in_bytes, vector<uint8_t>& out)

xrlatom_decode_value

#include <xrlatom-encoding.hh>

Decode escaped XrlAtom representation of XrlAtom binary data type.

Returns: -1 on success, or the index of the character causing the decode failure in the string "in" when an.

enum XrlAtomType { xrlatom_no_type = 0, xrlatom_int32, xrlatom_uint32, xrlatom_ipv4, xrlatom_ipv4net, xrlatom_ipv6, xrlatom_ipv6net, xrlatom_mac, xrlatom_text, xrlatom_list, xrlatom_boolean, xrlatom_binary, xrlatom_start = xrlatom_int32, xrlatom_end = xrlatom_binary }

XrlAtomType

#include <xrlatom.hh>

inline XrlAtomType&  operator++ (XrlAtomType& t)

operator++

#include <xrlatom.hh>

const char*  xrlatom_type_name (const XrlAtomType&)

xrlatom_type_name

#include <xrlatom.hh>

Returns: name of atom corresponding to type.

typedef const XrlCmdError  (*XrlCmdCallback) (const Xrl& request, XrlArgs* response, void* cookie)

(*XrlCmdCallback)

#include <xrlcmdmap.hh>

typedef XorpCallback2<const XrlCmdError, const Xrl&, XrlArgs*>::RefPtr XrlRecvCallback

XrlRecvCallback

#include <xrlcmdmap.hh>

inline bool  operator== (const XrlError& e1, const XrlError& e2)

operator==

#include <xrlerror.hh>

enum STCPPacketType { STCP_PT_HELO = 0x00, STCP_PT_REQUEST = 0x01, STCP_PT_RESPONSE = 0x02 }

STCPPacketType

#include <xrlpf-stcp-ph.hh>


Generated by: pavlin on possum.icir.org on Wed Dec 11 16:50:42 2002, using kdoc 2.0a54+XORP.