$search

XmlRpc::XmlRpcSocket Class Reference

A platform-independent socket API. More...

#include <XmlRpcSocket.h>

List of all members.

Static Public Member Functions

static int accept (int socket)
 Accept a client connection request.
static bool bind (int socket, int port)
 Bind to a specified port.
static void close (int socket)
 Closes a socket.
static bool connect (int socket, std::string &host, int port)
 Connect a socket to a server (from a client).
static int get_port (int socket)
static int getError ()
 Returns last errno.
static std::string getErrorMsg (int error)
 Returns message corresponding to error.
static std::string getErrorMsg ()
 Returns message corresponding to last error.
static bool listen (int socket, int backlog)
 Set socket in listen mode.
static bool nbRead (int socket, std::string &s, bool *eof)
 Read text from the specified socket. Returns false on error.
static bool nbWrite (int socket, std::string &s, int *bytesSoFar)
 Write text to the specified socket. Returns false on error.
static bool setNonBlocking (int socket)
 Sets a stream (TCP) socket to perform non-blocking IO. Returns false on failure.
static bool setReuseAddr (int socket)
static int socket ()
 Creates a stream (TCP) socket. Returns -1 on failure.

Detailed Description

A platform-independent socket API.

Definition at line 23 of file XmlRpcSocket.h.


Member Function Documentation

int XmlRpcSocket::accept ( int  socket  )  [static]

Accept a client connection request.

Definition at line 155 of file XmlRpcSocket.cpp.

bool XmlRpcSocket::bind ( int  socket,
int  port 
) [static]

Bind to a specified port.

Definition at line 135 of file XmlRpcSocket.cpp.

void XmlRpcSocket::close ( int  socket  )  [static]

Closes a socket.

Definition at line 99 of file XmlRpcSocket.cpp.

bool XmlRpcSocket::connect ( int  socket,
std::string &  host,
int  port 
) [static]

Connect a socket to a server (from a client).

Definition at line 172 of file XmlRpcSocket.cpp.

int XmlRpcSocket::get_port ( int  socket  )  [static]

Definition at line 318 of file XmlRpcSocket.cpp.

int XmlRpcSocket::getError (  )  [static]

Returns last errno.

Definition at line 288 of file XmlRpcSocket.cpp.

std::string XmlRpcSocket::getErrorMsg ( int  error  )  [static]

Returns message corresponding to error.

Definition at line 307 of file XmlRpcSocket.cpp.

std::string XmlRpcSocket::getErrorMsg (  )  [static]

Returns message corresponding to last error.

Definition at line 300 of file XmlRpcSocket.cpp.

bool XmlRpcSocket::listen ( int  socket,
int  backlog 
) [static]

Set socket in listen mode.

Definition at line 148 of file XmlRpcSocket.cpp.

bool XmlRpcSocket::nbRead ( int  socket,
std::string &  s,
bool *  eof 
) [static]

Read text from the specified socket. Returns false on error.

Definition at line 225 of file XmlRpcSocket.cpp.

bool XmlRpcSocket::nbWrite ( int  socket,
std::string &  s,
int *  bytesSoFar 
) [static]

Write text to the specified socket. Returns false on error.

Definition at line 258 of file XmlRpcSocket.cpp.

bool XmlRpcSocket::setNonBlocking ( int  socket  )  [static]

Sets a stream (TCP) socket to perform non-blocking IO. Returns false on failure.

Definition at line 113 of file XmlRpcSocket.cpp.

bool XmlRpcSocket::setReuseAddr ( int  socket  )  [static]

Allow the port the specified socket is bound to to be re-bound immediately so server re-starts are not delayed. Returns false on failure.

Definition at line 125 of file XmlRpcSocket.cpp.

int XmlRpcSocket::socket (  )  [static]

Creates a stream (TCP) socket. Returns -1 on failure.

Definition at line 91 of file XmlRpcSocket.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


xmlrpcpp
Author(s): Chris Morley and Konstantin Pilipchuk, slight modifications and ROS wrapping by Morgan Quigley
autogenerated on Sat Mar 2 13:22:54 2013