Bayonne2 / Common C++ 2 Framework: URLStream Class Reference

Bayonne2 / Common C++ 2 Framework

URLStream Class Reference

A URL processing version of TCPStream. More...

#include <url.h>

Inheritance diagram for URLStream:

Inheritance graph

[legend]

Collaboration diagram for URLStream:

Collaboration graph

[legend]

Public Types

enum Error {
  errSuccess = 0, errUnreachable, errMissing, errDenied,
  errInvalid, errForbidden, errUnauthorized, errRelocated,
  errFailure, errTimeout, errInterface
}

Return error for url fetch. More...

enum Authentication { authAnonymous = 0, authBasic }

Type of authentication. More...

enum Encoding { encodingBinary = 0, encodingChunked }

Encoding used in transfer. More...

enum Method {
methodHttpGet, methodHttpPut, methodHttpPost, methodHttpPostMultipart,
methodFtpGet, methodFtpPut, methodFileGet, methodFilePut
}

Type of fetch. More...

enum Protocol { protocolHttp1_0, protocolHttp1_1 }

http protocol version More...

enum Family { IPV4 = AF_INET }

typedef enum Family Family

enum Tos {
tosLowDelay = 0, tosThroughput, tosReliability, tosMinCost,
tosInvalid
}

typedef enum Tos Tos

enum Pending { pendingInput, pendingOutput, pendingError }

typedef enum Pending Pending

Public Member Functions

URLStream (Family family=IPV4, timeout_t timer=0)

Construct an instance of URL stream. More...

URLStream & getline (char *buffer, size_t len)

Line parsing with conversion. More...

Error get (const char *url, size_t buffer=512)

Get URL data from a named stream of a known buffer size. More...

Error get (size_t buffer=512)

Get URL data from a named stream of a known buffer size. More...

Error submit (const char *url, const char **vars, size_t buffer=512)

Submit URL with vars passed as argument array. More...

Error post (const char *url, const char **vars, size_t buffer=512)

Post URL vars with post method. More...

Error post (const char *url, MIMEMultipartForm &form, size_t buffer=512)

Post URL with MIME multipart form. More...

Error head (const char *url, size_t buffer=512)

Used to fetch header information for a resource. More...

void close ()

Close the URL stream for a new connection. More...

void setReferer (const char *str)

Set the referer url. More...

void setHost (const char *str)

Set the host for the url. More...

void setAddress (const char *str)

Set the address for the url. More...

void setCookie (const char *str)

Set the cookie to pass. More...

void setUser (const char *str)

Set user id for the url. More...

void setPassword (const char *str)

Set password for the url. More...

void setAuthentication (Authentication a, const char *str=NULL)

Set authentication type for the url. More...

void setProxyUser (const char *str)

Set proxy user id for the url. More...

void setProxyPassword (const char *str)

Set proxy password for the url. More...

void setProxyAuthentication (Authentication a, const char *str=NULL)

Set proxy authentication type for the url. More...

void setPragma (const char *str)

Set the pragmas. More...

void setProxy (const char *host, tpport_t port)

Set the proxy server used. More...

void setAgent (const char *str)

Set the agent. More...

Method getMethod (void)

Get url method (and protocol) employed. More...

void setTimeout (timeout_t to)

Set socket timeout characteristics for processing URL requests. More...

void setFollow (bool enable)

Specify url following. More...

void setProtocol (Protocol pro)

Specify http protocol level being used. More...

void setLocalInterface (const char *intf)

Specify local interface to use. More...

void disconnect (void)

Disconnect the current session and prepare for a new one. More...

int getSegmentSize (void)

Get protocol segment size. More...

void connect (TCPSocket &server)

Accept a connection from a TCP Server. More...

int sync (void)

Flushes the stream input and output buffers, writes pending output. More...

bool isPending (Pending pend, timeout_t timeout=TIMEOUT_INF)

Get the status of pending stream data. More...

ssize_t peek (void *buf, size_t len)

Examine contents of next waiting packet. More...

size_t getBufferSize (void) const

Return the size of the current stream buffering used. More...

virtual IPV4Host getIPV4Sender (tpport_t *port=NULL) const

May be used to examine the origin of data waiting in the socket receive queue. More...

IPV4Host getSender (tpport_t *port=NULL) const

IPV4Host getIPV4Peer (tpport_t *port=NULL) const

Get the host address and port of the socket this socket is connected to. More...

IPV4Host getPeer (tpport_t *port=NULL) const

IPV4Host getIPV4Local (tpport_t *port=NULL) const

Get the local address and port number this socket is currently bound to. More...

IPV4Host getLocal (tpport_t *port=NULL) const

IPV4Host getIPV4NAT (tpport_t *port=NULL) const

Perform NAT table lookup for this socket. More...

IPV4Host getNAT (tpport_t *port) const

void setCompletion (bool immediate)

Used to specify blocking mode for the socket. More...

Error setLinger (bool linger)

Enable lingering sockets on close. More...

Error setKeepAlive (bool enable)

Set the keep-alive status of this socket and if keep-alive messages will be sent. More...

Error setTypeOfService (Tos service)

Set packet scheduling on platforms which support ip quality of service conventions. More...

bool isConnected (void) const

Can test to see if this socket is "connected", and hence whether a "catch" can safely call getPeer(). More...

bool isActive (void) const

Test to see if the socket is at least operating or if it is mearly initialized. More...

bool operator! () const

Operator based testing to see if a socket is currently active. More...

bool isBroadcast (void) const

Return if broadcast has been enabled for the specified socket. More...

bool isRouted (void) const

Return if socket routing is enabled. More...

Error getErrorNumber (void) const

Often used by a "catch" to fetch the last error of a thrown socket. More...

const char * getErrorString (void) const

Often used by a "catch" to fetch the user set error string of a thrown socket, but only if EXTENDED error codes are used. More...

long getSystemError (void) const

const char * getSystemErrorString (void) const

Static Public Member Functions

static bool check (Family fam)

See if a specific protocol family is available in the current runtime environment. More...

Protected Types

enum State {
INITIAL, AVAILABLE, BOUND, CONNECTED,
CONNECTING, STREAM
}

typedef enum State State

Protected Member Functions

Error sendHTTPHeader (const char *url, const char **vars, size_t bufsize)

Send http header to server. More...

int underflow (void)

Called if stream buffer needs refilling. More...

virtual int aRead (char *buffer, size_t len, timeout_t timer)

Derived method for async or timed I/O function on url stream. More...

virtual int aWrite (char *buffer, size_t len, timeout_t timer)

Derived method for async or timed I/O function on url stream. More...

virtual void httpHeader (const char *header, const char *value)

Derived method to receive and parse http "headers". More...

virtual char ** extraHeader (void)

A virtual to insert additional header info into the request. More...

void allocate (size_t size)

Used to allocate the buffer space needed for iostream operations. More...

void endStream (void)

Used to terminate the buffer space and cleanup the socket connection. More...

int uflow ()

This streambuf method is used for doing unbuffered reads through the establish tcp socket connection when in interactive mode. More...

int overflow (int ch)

This streambuf method is used to write the output buffer through the established tcp connection. More...

void connect (const IPV4Host &host, tpport_t port, unsigned mss=536)

Create a TCP stream by connecting to a TCP socket (on a remote machine). More...

void connect (const char *name, unsigned mss=536)

Connect a TCP stream to a named destination host and port number, using getaddrinfo interface if available. More...

std::iostream * tcp (void)

Used in derived classes to refer to the current object via it's iostream. More...

Error error (Error error, const char *err=NULL, long systemError=0) const

This service is used to throw all socket errors which usually occur during the socket constructor. More...

void error (const char *err) const

This service is used to throw application defined socket errors where the application specific error code is a string. More...

void setError (bool enable)

This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag. More...

void endSocket (void)

Used as the default destructor for ending a socket. More...

Error connectError (void)

Used as a common handler for connection failure processing. More...

Error sendLimit (int limit=2048)

Set the send limit. More...

Error receiveLimit (int limit=1)

Set thr receive limit. More...

Error sendTimeout (timeout_t timer)

Set the send timeout for sending raw network data. More...

Error receiveTimeout (timeout_t timer)

Receive timeout for receiving raw network data. More...

Error sendBuffer (unsigned size)

Set the protocol stack network kernel send buffer size associated with the socket. More...

Error receiveBuffer (unsigned size)

Set the protocol stack network kernel receive buffer size associated with the socket. More...

Error bufferSize (unsigned size)

Set the total protocol stack network kernel buffer size for both send and receive together. More...

Error setBroadcast (bool enable)

Set the subnet broadcast flag for the socket. More...

Error setMulticastByFamily (bool enable, Family family=IPV4)

Setting multicast binds the multicast interface used for the socket to the interface the socket itself has been implicitly bound to. More...

Error setLoopbackByFamily (bool enable, Family family=IPV4)

Set the multicast loopback flag for the socket. More...

Error setTimeToLiveByFamily (unsigned char ttl, Family fam=IPV4)

Set the multicast time to live for a multicast socket. More...

Error join (const IPV4Multicast &ia)

Join a multicast group. More...

Error drop (const IPV4Multicast &ia)

Drop membership from a multicast group. More...

Error setRouting (bool enable)

Set the socket routing to indicate if outgoing messages should bypass normal routing (set false). More...

Error setNoDelay (bool enable)

Enable/disable delaying packets (Nagle algorithm) More...

ssize_t readLine (char *buf, size_t len, timeout_t timeout=0)

Process a logical input line from a socket descriptor directly. More...

virtual ssize_t readData (void *buf, size_t len, char separator=0, timeout_t t=0)

Read in a block of len bytes with specific separator. More...

virtual ssize_t writeData (const void *buf, size_t len, timeout_t t=0)

Write a block of len bytes to socket. More...

Protected Attributes

ost::String m_host

ost::String m_address

size_t bufsize

Family family

char * gbuf

char * pbuf

struct {

bool thrown: 1

bool broadcast: 1

bool route: 1

bool keepalive: 1

bool loopback: 1

bool multicast: 1

bool completion: 1

bool linger: 1

unsigned ttl: 8

} flags

SOCKET volatile so

the actual socket descriptor, in Windows, unlike posix it cannot be used as an file descriptor that way madness lies – jfc More...

State volatile state

Static Protected Attributes

static Mutex mutex

Private Member Functions

Error getHTTPHeaders ()

URLStream (const URLStream &rhs)

Private Attributes

const char * agent

const char * referer

const char * cookie

const char * pragma

const char * user

const char * password

const char * proxyUser

const char * proxyPasswd

const char * localif

IPV4Host proxyHost

tpport_t proxyPort

Method urlmethod

Encoding encoding

Protocol protocol

Authentication auth

Authentication proxyAuth

timeout_t timeout

bool persistent

bool follow

unsigned chunk

Related Functions

(Note that these are not member functions.)

__EXPORT char * urlDecode (char *source, char *dest=NULL)

__EXPORT char * urlEncode (const char *source, char *dest, size_t size)

__EXPORT char * b64Decode (char *src, char *dest=NULL)

__EXPORT char * b64Encode (const char *source, char *dest, size_t size)

__EXPORT size_t b64Encode (const unsigned char *src, size_t srcsize, char *dst, size_t dstsize)

__EXPORT size_t b64Decode (const char *src, unsigned char *dst, size_t dstsize)

__EXPORT String b64Encode (const String &src)

__EXPORT String b64Decode (const String &src)

__EXPORT String b64Encode (const unsigned char *src, size_t srcsize)

__EXPORT size_t b64Decode (const String &src, unsigned char *dst, size_t dstsize)

Detailed Description

A URL processing version of TCPStream.

Author: David Sugar dyfet.nosp@m.@ost.nosp@m.el.co.nosp@m.m C++ url processing stream class.

Definition at line 69 of file url.h.

Member Typedef Documentation

typedef enum Family Socket::Family

inherited

Definition at line 129 of file socket.h.

typedef enum Pending Socket::Pending

inherited

Definition at line 179 of file socket.h.

typedef enum State Socket::State

protectedinherited

Definition at line 190 of file socket.h.

typedef enum Tos Socket::Tos

inherited

Definition at line 172 of file socket.h.

Member Enumeration Documentation

enum URLStream::Authentication

Type of authentication.

Enumerator
authAnonymous
authBasic

Definition at line 92 of file url.h.

enum URLStream::Encoding

Encoding used in transfer.

Enumerator
encodingBinary
encodingChunked

Definition at line 100 of file url.h.

enum URLStream::Error

Return error for url fetch.

Enumerator
errSuccess
errUnreachable
errMissing
errDenied
errInvalid
errForbidden
errUnauthorized
errRelocated
errFailure
errTimeout
errInterface

Definition at line 75 of file url.h.

enum Socket::Family

inherited

Enumerator
IPV4

Definition at line 122 of file socket.h.

enum URLStream::Method

Type of fetch.

Enumerator
methodHttpGet
methodHttpPut
methodHttpPost
methodHttpPostMultipart
methodFtpGet
methodFtpPut
methodFileGet
methodFilePut

Definition at line 108 of file url.h.

enum Socket::Pending

inherited

Enumerator
pendingInput
pendingOutput
pendingError

Definition at line 174 of file socket.h.

enum URLStream::Protocol

http protocol version

Enumerator
protocolHttp1_0
protocolHttp1_1

Definition at line 122 of file url.h.

enum Socket::State

protectedinherited

Enumerator
INITIAL
AVAILABLE
BOUND
CONNECTED
CONNECTING
STREAM

Definition at line 182 of file socket.h.

enum Socket::Tos

inherited

Enumerator
tosLowDelay
tosThroughput
tosReliability
tosMinCost
tosInvalid

Definition at line 165 of file socket.h.

Constructor & Destructor Documentation

URLStream::URLStream ( const URLStream & rhs )

private

URLStream::URLStream ( Family family = IPV4 ,

timeout_t timer = 0

)

Construct an instance of URL stream.

Parameters: family protocol to use.

timer for default timeout on I/O operations.

Member Function Documentation

void TCPStream::allocate ( size_t size )

protectedinherited

Used to allocate the buffer space needed for iostream operations.

This function is called by the constructor.

Parameters: size of stream buffers from constructor.

virtual int URLStream::aRead ( char * buffer,

size_t len,

timeout_t timer

)

protectedvirtual

Derived method for async or timed I/O function on url stream.

Returns: number of bytes read or < 0 for error.

Parameters: buffer to read stream data into.

len of bytes to read from stream.

timer to wait for data in milliseconds.

virtual int URLStream::aWrite ( char * buffer,

size_t len,

timeout_t timer

)

protectedvirtual

Derived method for async or timed I/O function on url stream.

Returns: number of bytes written or < 0 for error.

Parameters: buffer to write stream data from.

len of bytes to write to stream.

timer to wait for data in milliseconds.

Error Socket::bufferSize ( unsigned size )

protectedinherited

Set the total protocol stack network kernel buffer size for both send and receive together.

Returns: errSuccess on success

Parameters: size of buffer.

static bool Socket::check ( Family fam )

staticinherited

See if a specific protocol family is available in the current runtime environment.

Returns: true if family available.

void URLStream::close ( )

Close the URL stream for a new connection.

void TCPStream::connect ( const IPV4Host & host,

tpport_t port,

unsigned mss = 536

)

protectedinherited

Create a TCP stream by connecting to a TCP socket (on a remote machine).

Parameters: host address of remote TCP server.

port number to connect.

mss maximum segment size of streaming buffers.

void TCPStream::connect ( const char * name,

unsigned mss = 536

)

protectedinherited

Connect a TCP stream to a named destination host and port number, using getaddrinfo interface if available.

Parameters: name of host and service to connect

mss maximum segment size of stream buffer

void TCPStream::connect ( TCPSocket & server )

inherited

Accept a connection from a TCP Server.

Parameters: server socket listening

Error Socket::connectError ( void )

protectedinherited

Used as a common handler for connection failure processing.

Returns: correct failure code to apply.

void TCPStream::disconnect ( void )

inherited

Disconnect the current session and prepare for a new one.

Error Socket::drop ( const IPV4Multicast & ia )

protectedinherited

Drop membership from a multicast group.

Returns: 0 (errSuccess) on success, else error code.

Parameters: ia address of multicast group to drop.

void Socket::endSocket ( void )

protectedinherited

Used as the default destructor for ending a socket.

This will cleanly terminate the socket connection. It is provided for use in derived virtual destructors.

void TCPStream::endStream ( void )

protectedinherited

Used to terminate the buffer space and cleanup the socket connection.

This fucntion is called by the destructor.

Error Socket::error ( Error error,

const char * err = NULL,

long systemError = 0

) const

protectedinherited

This service is used to throw all socket errors which usually occur during the socket constructor.

Parameters: error defined socket error id.

err string or message to pass.

systemError the system error# that caused the error

void Socket::error ( const char * err ) const

inlineprotectedinherited

This service is used to throw application defined socket errors where the application specific error code is a string.

Parameters: err string or message to pass.

Definition at line 240 of file socket.h.

virtual char** URLStream::extraHeader ( void )

protectedvirtual

A virtual to insert additional header info into the request.

Returns: array of header attributes to add.

Error URLStream::get ( const char * url,

size_t buffer = 512

)

Get URL data from a named stream of a known buffer size.

Returns: url error code.

Parameters: url name of resource.

buffer size of buffer.

Error URLStream::get ( size_t buffer = 512 )

Get URL data from a named stream of a known buffer size.

Requesting URL defined in previous calls of setAddress() and setHost() functions.

Returns: url error code.

Parameters: buffer size of buffer.

size_t TCPStream::getBufferSize ( void ) const

inlineinherited

Return the size of the current stream buffering used.

Returns: size of stream buffers.

Definition at line 1853 of file socket.h.

Error Socket::getErrorNumber ( void ) const

inlineinherited

Often used by a "catch" to fetch the last error of a thrown socket.

Returns: error number of Error error.

Definition at line 668 of file socket.h.

const char* Socket::getErrorString ( void ) const

inlineinherited

Often used by a "catch" to fetch the user set error string of a thrown socket, but only if EXTENDED error codes are used.

Returns: string for error message.

Definition at line 676 of file socket.h.

Error URLStream::getHTTPHeaders ( )

private

IPV4Host Socket::getIPV4Local ( tpport_t * port = NULL ) const

inherited

Get the local address and port number this socket is currently bound to.

Parameters: port ptr to port number on local host.

Returns: host address of interface this socket is bound to.

IPV4Host Socket::getIPV4NAT ( tpport_t * port = NULL ) const

inherited

Perform NAT table lookup for this socket.

Used to allow an application to know the original ip:port pair the the client "thinks" it is connecting to. Used mostly to transparently impersonate a remote server/service.

On error, 0.0.0.0:0 is returned and one of the following error codes is set: errServiceUnavailable - if nat is not supported on the current platform or if it was not compiled; errLookupFail - if the nat syscall failed for some reason (extended error code); errSearchErr - if the socket does not have nat information (i.e. is not nated).

NAT lookup is supported on NetFilter for ipv4 and ipv6 (Linux), IPFilter for ipv4 (Solaris, *BSD except OpenBSD, HP-UX, etc.) and Packet Filter for ipv4 and ipv6 (OpenBSD). When using IPFilter or Packet Filter, the first NAT lookup must be performed as root (the NAT device is read only for root and is opened once, unless an error occurs). Permissions on the nat device may be changed to solve this.

Warning: When using IPFilter and Packet Filter, application data model must be the same as the running kernel (32/64 bits).

Parameters: port ptr to NATed port number on local host.

Returns: NATed host address that this socket is related to.

IPV4Host Socket::getIPV4Peer ( tpport_t * port = NULL ) const

inherited

Get the host address and port of the socket this socket is connected to.

If the socket is currently not in a connected state, then a host address of 0.0.0.0 is returned.

Parameters: port ptr to port number of remote socket.

Returns: host address of remote socket.

virtual IPV4Host Socket::getIPV4Sender ( tpport_t * port = NULL ) const

virtualinherited

May be used to examine the origin of data waiting in the socket receive queue.

This can tell a TCP server where pending "connect" requests are coming from, or a UDP socket where it's next packet arrived from.

Parameters: port ptr to port number of sender.

Returns: host address, test with "isInetAddress()".

Reimplemented in DCCPSocket.

URLStream& URLStream::getline ( char * buffer,

size_t len

)

Line parsing with conversion.

Returns: URLStream object reference.

Parameters: buffer to store.

len maximum buffer size.

IPV4Host Socket::getLocal ( tpport_t * port = NULL ) const

inlineinherited

Definition at line 539 of file socket.h.

Method URLStream::getMethod ( void )

inline

Get url method (and protocol) employed.

Returns: url method in effect.

Definition at line 394 of file url.h.

IPV4Host Socket::getNAT ( tpport_t * port ) const

inlineinherited

Definition at line 575 of file socket.h.

IPV4Host Socket::getPeer ( tpport_t * port = NULL ) const

inlineinherited

Definition at line 523 of file socket.h.

int TCPStream::getSegmentSize ( void )

inherited

Get protocol segment size.

IPV4Host Socket::getSender ( tpport_t * port = NULL ) const

inlineinherited

Definition at line 505 of file socket.h.

long Socket::getSystemError ( void ) const

inlineinherited

Definition at line 678 of file socket.h.

const char* Socket::getSystemErrorString ( void ) const

inherited

Error URLStream::head ( const char * url,

size_t buffer = 512

)

Used to fetch header information for a resource.

Returns: url error code.

Parameters: url name of resource.

buffer size of buffer.

virtual void URLStream::httpHeader ( const char * header,

const char * value

)

protectedvirtual

Derived method to receive and parse http "headers".

Parameters: header keyword.

value header keyword value.

bool Socket::isActive ( void ) const

inherited

Test to see if the socket is at least operating or if it is mearly initialized.

"initialized" sockets may be the result of failed constructors.

Returns: true if not in initial state.

bool Socket::isBroadcast ( void ) const

inlineinherited

Return if broadcast has been enabled for the specified socket.

Returns: true if broadcast socket.

Definition at line 651 of file socket.h.

bool Socket::isConnected ( void ) const

inherited

Can test to see if this socket is "connected", and hence whether a "catch" can safely call getPeer().

Of course, an unconnected socket will return a 0.0.0.0 address from getPeer() as well.

Returns: true when socket is connected to a peer.

bool TCPStream::isPending ( Pending pend,

timeout_t timeout = TIMEOUT_INF

)

virtualinherited

Get the status of pending stream data.

This can be used to examine if input or output is waiting, or if an error or disconnect has occured on the stream. If a read buffer contains data then input is ready and if write buffer contains data it is first flushed and then checked.

Reimplemented from Socket.

bool Socket::isRouted ( void ) const

inlineinherited

Return if socket routing is enabled.

Returns: true if routing enabled.

Definition at line 659 of file socket.h.

Error Socket::join ( const IPV4Multicast & ia )

protectedinherited

Join a multicast group.

Returns: 0 (errSuccess) on success, else error code.

Parameters: ia address of multicast group to join.

bool Socket::operator! ( ) const

inherited

Operator based testing to see if a socket is currently active.

int TCPStream::overflow ( int ch )

protectedinherited

This streambuf method is used to write the output buffer through the established tcp connection.

Parameters: ch char to push through.

Returns: char pushed through.

ssize_t TCPStream::peek ( void * buf,

size_t len

)

inlineinherited

Examine contents of next waiting packet.

Parameters: buf pointer to packet buffer for contents.

len of packet buffer.

Returns: number of bytes examined.

Definition at line 1845 of file socket.h.

Error URLStream::post ( const char * url,

const char ** vars,

size_t buffer = 512

)

Post URL vars with post method.

Returns: success or error code.

Parameters: url name of resource being posted.

vars to set in post.

buffer size of buffer.

Error URLStream::post ( const char * url,

MIMEMultipartForm & form,

size_t buffer = 512

)

Post URL with MIME multipart form.

Returns: success or error code.

Parameters: url name of resource being posted.

form multi-part resource.

buffer size to use.

virtual ssize_t Socket::readData ( void * buf,

size_t len,

char separator = 0,

timeout_t t = 0

)

protectedvirtualinherited

Read in a block of len bytes with specific separator.

Can be zero, or any other char. If \n or \r, it's treated just like a readLine(). Otherwise it looks for the separator.

Parameters: buf pointer to byte allocation.

len maximum length to read.

separator separator for a particular ASCII character

t timeout for pending data in milliseconds.

Returns: number of bytes actually read.

ssize_t Socket::readLine ( char * buf,

size_t len,

timeout_t timeout = 0

)

protectedinherited

Process a logical input line from a socket descriptor directly.

Parameters: buf pointer to string.

len maximum length to read.

timeout for pending data in milliseconds.

Returns: number of bytes actually read.

Error Socket::receiveBuffer ( unsigned size )

protectedinherited

Set the protocol stack network kernel receive buffer size associated with the socket.

Returns: errSuccess on success, or error.

Parameters: size of buffer in bytes.

Error Socket::receiveLimit ( int limit = 1 )

protectedinherited

Set thr receive limit.

Error Socket::receiveTimeout ( timeout_t timer )

protectedinherited

Receive timeout for receiving raw network data.

Returns: errSuccess if set.

Parameters: timer value in milliseconds.

Error Socket::sendBuffer ( unsigned size )

protectedinherited

Set the protocol stack network kernel send buffer size associated with the socket.

Returns: errSuccess on success, or error.

Parameters: size of buffer in bytes.

Error URLStream::sendHTTPHeader ( const char * url,

const char ** vars,

size_t bufsize

)

protected

Send http header to server.

Parameters: url base to send header to

vars to post or use in get method

bufsize of stream buffering to use

Returns: success or class error

Error Socket::sendLimit ( int limit = 2048 )

protectedinherited

Set the send limit.

Error Socket::sendTimeout ( timeout_t timer )

protectedinherited

Set the send timeout for sending raw network data.

Returns: errSuccess if set.

Parameters: timer value in millisec.

void URLStream::setAddress ( const char * str )

inline

Set the address for the url.

Parameters: str address in the URL.

Definition at line 306 of file url.h.

void URLStream::setAgent ( const char * str )

inline

Set the agent.

Parameters: str agent value.

Definition at line 386 of file url.h.

void URLStream::setAuthentication ( Authentication a,

const char * str = NULL

)

Set authentication type for the url.

Parameters: a authentication.

str string.

Error Socket::setBroadcast ( bool enable )

protectedinherited

Set the subnet broadcast flag for the socket.

This enables sending to a subnet and may require special image privileges depending on the operating system.

Returns: 0 (errSuccess) on success, else error code.

Parameters: enable when set to true.

void Socket::setCompletion ( bool immediate )

inherited

Used to specify blocking mode for the socket.

A socket can be made non-blocking by setting setCompletion(false) or set to block on all access with setCompletion(true). I do not believe this form of non-blocking socket I/O is supported in winsock, though it provides an alternate asynchronous set of socket services.

Parameters: immediate mode specify socket I/O call blocking mode.

void URLStream::setCookie ( const char * str )

inline

Set the cookie to pass.

Parameters: str cookie string.

Definition at line 314 of file url.h.

void Socket::setError ( bool enable )

inlineprotectedinherited

This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag.

Parameters: enable true to enable handler.

Definition at line 249 of file socket.h.

void URLStream::setFollow ( bool enable )

inline

Specify url following.

Set to false to disable following of relocation requests.

Parameters: enable true to enable following.

Definition at line 412 of file url.h.

void URLStream::setHost ( const char * str )

inline

Set the host for the url.

Parameters: str host address.

Definition at line 298 of file url.h.

Error Socket::setKeepAlive ( bool enable )

inherited

Set the keep-alive status of this socket and if keep-alive messages will be sent.

Returns: 0 on success.

Parameters: enable keep alive messages.

Error Socket::setLinger ( bool linger )

inherited

Enable lingering sockets on close.

Parameters: linger specify linger enable.

void URLStream::setLocalInterface ( const char * intf )

inline

Specify local interface to use.

Parameters: intf Local interface name

Definition at line 427 of file url.h.

Error Socket::setLoopbackByFamily ( bool enable,

Family family = IPV4

)

protectedinherited

Set the multicast loopback flag for the socket.

Loopback enables a socket to hear what it is sending.

Returns: 0 (errSuccess) on success, else error code.

Parameters: enable when set to true.

family of protocol.

Error Socket::setMulticastByFamily ( bool enable,

Family family = IPV4

)

protectedinherited

Setting multicast binds the multicast interface used for the socket to the interface the socket itself has been implicitly bound to.

It is also used as a check flag to make sure multicast is enabled before multicast operations are used.

Returns: 0 (errSuccess) on success, else error code.

Parameters: enable when set to true.

family of protocol.

Error Socket::setNoDelay ( bool enable )

protectedinherited

Enable/disable delaying packets (Nagle algorithm)

Returns: 0 on success.

Parameters: enable disable Nagle algorithm when set to true.

void URLStream::setPassword ( const char * str )

inline

Set password for the url.

Parameters: str password.

Definition at line 330 of file url.h.

void URLStream::setPragma ( const char * str )

inline

Set the pragmas.

Parameters: str pragma setting.

Definition at line 370 of file url.h.

void URLStream::setProtocol ( Protocol pro )

inline

Specify http protocol level being used.

Parameters: pro protocol level.

Definition at line 420 of file url.h.

void URLStream::setProxy ( const char * host,

tpport_t port

)

Set the proxy server used.

Parameters: host proxy host.

port proxy port.

void URLStream::setProxyAuthentication ( Authentication a,

const char * str = NULL

)

Set proxy authentication type for the url.

Parameters: a authentication.

str string.

void URLStream::setProxyPassword ( const char * str )

inline

Set proxy password for the url.

Parameters: str password.

Definition at line 354 of file url.h.

void URLStream::setProxyUser ( const char * str )

inline

Set proxy user id for the url.

Parameters: str user id.

Definition at line 346 of file url.h.

void URLStream::setReferer ( const char * str )

Set the referer url.

Parameters: str referer string.

Error Socket::setRouting ( bool enable )

protectedinherited

Set the socket routing to indicate if outgoing messages should bypass normal routing (set false).

Returns: 0 on success.

Parameters: enable normal routing when set to true.

void URLStream::setTimeout ( timeout_t to )

inline

Set socket timeout characteristics for processing URL requests.

Set to 0 for no default timeouts.

Parameters: to timeout to set.

Definition at line 403 of file url.h.

Error Socket::setTimeToLiveByFamily ( unsigned char ttl,

Family fam = IPV4

)

protectedinherited

Set the multicast time to live for a multicast socket.

Returns: 0 (errSuccess) on success, else error code.

Parameters: ttl time to live.

fam family of protocol.

Error Socket::setTypeOfService ( Tos service )

inherited

Set packet scheduling on platforms which support ip quality of service conventions.

This effects how packets in the queue are scheduled through the interface.

Returns: 0 on success, error code on failure.

Parameters: service type of service enumerated type.

void URLStream::setUser ( const char * str )

inline

Set user id for the url.

Parameters: str user id.

Definition at line 322 of file url.h.

Error URLStream::submit ( const char * url,

const char ** vars,

size_t buffer = 512

)

Submit URL with vars passed as argument array.

This submit assumes "GET" method. Use "post" member to perform post.

Returns: url error code.

Parameters: url name of resource.

vars to set.

buffer size of buffer.

int TCPStream::sync ( void )

inherited

Flushes the stream input and output buffers, writes pending output.

Returns: 0 on success.

std::iostream* TCPStream::tcp ( void )

inlineprotectedinherited

Used in derived classes to refer to the current object via it's iostream.

For example, to send a set of characters in a derived method, one might use *tcp() << "test".

Returns: stream pointer of this object.

Definition at line 1735 of file socket.h.

int TCPStream::uflow ( )

protectedinherited

This streambuf method is used for doing unbuffered reads through the establish tcp socket connection when in interactive mode.

Also this method will handle proper use of buffers if not in interative mode.

Returns: char from tcp socket connection, EOF if not connected.

int URLStream::underflow ( void )

protected

Called if stream buffer needs refilling.

Returns: number of bytes refilled or error if < 0

virtual ssize_t Socket::writeData ( const void * buf,

size_t len,

timeout_t t = 0

)

protectedvirtualinherited

Write a block of len bytes to socket.

Parameters: buf pointer to byte allocation.

len maximum length to write.

t timeout for pending data in milliseconds.

Returns: number of bytes actually written.

Friends And Related Function Documentation

__EXPORT char * b64Decode ( char * src,

char * dest = NULL

)

Decode a string using base64 coding. Destination size should be at least strlen(src)+1. Destination will be a string, so is always terminated . This function is deprecated, base64 can use binary source, not only string use overloaded b64Decode.

Returns: string coded

Parameters: src source buffer

dest destination buffer. If NULL src is used

__EXPORT size_t b64Decode ( const char * src,

unsigned char * dst,

size_t dstsize

)

Decode a string using base64 coding. Destination size should be at least strlen(src)/4*3. Destination are not string terminated (It's just a octet stream).

Returns: number of octets written into destination buffer

Parameters: src source string

dst destination octet buffer

dstsize destination buffer size

__EXPORT String b64Decode ( const String & src )

Decode a STL string using base64 coding into an STL String. Destination size should be at least strlen(src)/4*3. Destination are not string terminated (It's just a octet stream).

Returns: decoded string

Parameters: src source string

__EXPORT size_t b64Decode ( const String & src,

unsigned char * dst,

size_t dstsize

)

Decode a string using base64 coding. Destination size should be at least strlen(src)/4*3. Destination are not string terminated (It's just a octet stream).

Returns: number of octets written into destination buffer

Parameters: src source string

dst destination octet buffer

dstsize destination buffer size

__EXPORT char * b64Encode ( const char * source,

char * dest,

size_t size

)

Encode a string using base64 coding. Destination size should be at least strlen(src)/4*3+1. Destination is string terminated. This function is deprecated, coded stream can contain terminator character use overloaded b64Encode instead.

Returns: destination buffer

Parameters: source source string

dest destination octet buffer

size destination buffer size

__EXPORT size_t b64Encode ( const unsigned char * src,

size_t srcsize,

char * dst,

size_t dstsize

)

Encode a octet stream using base64 coding. Destination size should be at least (srcsize+2)/3*4+1. Destination will be a string, so is always terminated (unless you pass dstsize == 0).

Returns: size of string written not counting terminator

Parameters: src source buffer

srcsize source buffer size

dst destination buffer

dstsize destination buffer size

__EXPORT String b64Encode ( const String & src )

Encode a STL string using base64 coding into a STL string

Returns: base 64 encoded string

Parameters: src source string

__EXPORT String b64Encode ( const unsigned char * src,

size_t srcsize

)

Encode a octet stream using base64 coding into a STL string

Returns: base 64 encoded string

Parameters: src source buffer

srcsize source buffer size

__EXPORT char * urlDecode ( char * source,

char * dest = NULL

)

Decode an url parameter (ie "\%20" -> " ")

Parameters: source string

dest destination buffer. If NULL source is used

__EXPORT char * urlEncode ( const char * source,

char * dest,

size_t size

)

Encode an url parameter (ie " " -> "+")

Parameters: source string

dest destination buffer. Do not overlap with source

size destination buffer size.

Field Documentation

const char* URLStream::agent

private

Definition at line 128 of file url.h.

Authentication URLStream::auth

private

Definition at line 139 of file url.h.

bool Socket::broadcast

inherited

Definition at line 206 of file socket.h.

size_t TCPStream::bufsize

protectedinherited

Definition at line 1643 of file socket.h.

unsigned URLStream::chunk

private

Definition at line 144 of file url.h.

bool Socket::completion

inherited

Definition at line 211 of file socket.h.

const char * URLStream::cookie

private

Definition at line 128 of file url.h.

Encoding URLStream::encoding

private

Definition at line 137 of file url.h.

Family TCPStream::family

protectedinherited

Definition at line 1644 of file socket.h.

struct { ... } Socket::flags

bool URLStream::follow

private

Definition at line 143 of file url.h.

char* TCPStream::gbuf

protectedinherited

Definition at line 1645 of file socket.h.

bool Socket::keepalive

inherited

Definition at line 208 of file socket.h.

bool Socket::linger

inherited

Definition at line 212 of file socket.h.

const char* URLStream::localif

private

Definition at line 130 of file url.h.

bool Socket::loopback

inherited

Definition at line 209 of file socket.h.

ost::String URLStream::m_address

protected

Definition at line 150 of file url.h.

ost::String URLStream::m_host

protected

Definition at line 150 of file url.h.

bool Socket::multicast

inherited

Definition at line 210 of file socket.h.

Mutex Socket::mutex

staticprotectedinherited

Definition at line 202 of file socket.h.

const char * URLStream::password

private

Definition at line 128 of file url.h.

char * TCPStream::pbuf

protectedinherited

Definition at line 1645 of file socket.h.

bool URLStream::persistent

private

Definition at line 142 of file url.h.

const char * URLStream::pragma

private

Definition at line 128 of file url.h.

Protocol URLStream::protocol

private

Definition at line 138 of file url.h.

Authentication URLStream::proxyAuth

private

Definition at line 140 of file url.h.

IPV4Host URLStream::proxyHost

private

Definition at line 131 of file url.h.

const char * URLStream::proxyPasswd

private

Definition at line 129 of file url.h.

tpport_t URLStream::proxyPort

private

Definition at line 135 of file url.h.

const char* URLStream::proxyUser

private

Definition at line 129 of file url.h.

const char * URLStream::referer

private

Definition at line 128 of file url.h.

bool Socket::route

inherited

Definition at line 207 of file socket.h.

SOCKET volatile Socket::so

protectedinherited

the actual socket descriptor, in Windows, unlike posix it cannot be used as an file descriptor that way madness lies – jfc

Definition at line 221 of file socket.h.

State volatile Socket::state

protectedinherited

Definition at line 222 of file socket.h.

bool Socket::thrown

inherited

Definition at line 205 of file socket.h.

timeout_t URLStream::timeout

private

Definition at line 141 of file url.h.

unsigned Socket::ttl

inherited

Definition at line 213 of file socket.h.

Method URLStream::urlmethod

private

Definition at line 136 of file url.h.

const char * URLStream::user

private

Definition at line 128 of file url.h.

The documentation for this class was generated from the following file:

url.h

Generated on Dec 21, 2017 for commoncpp2-1.8.1, ccrtp-1.7.2, libzrtpcpp-2.3.4, ccscript3-1.1.7, ccaudio2-1.0.0 and bayonne2-2.3.2 (after installation in /usr/local/) by doxygen 1.8.6