Bayonne2 / Common C++ 2 Framework
|
A URL processing version of TCPStream. More...
#include <url.h>
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) |
|
inherited |
|
inherited |
|
protectedinherited |
|
inherited |
enum URLStream::Encoding |
enum URLStream::Error |
|
inherited |
enum URLStream::Method |
|
inherited |
enum URLStream::Protocol |
|
protectedinherited |
|
inherited |
|
private |
Construct an instance of URL stream.
family | protocol to use. |
timer | for default timeout on I/O operations. |
|
protectedinherited |
Used to allocate the buffer space needed for iostream operations.
This function is called by the constructor.
size | of stream buffers from constructor. |
|
protectedvirtual |
Derived method for async or timed I/O function on url stream.
buffer | to read stream data into. |
len | of bytes to read from stream. |
timer | to wait for data in milliseconds. |
|
protectedvirtual |
Derived method for async or timed I/O function on url stream.
buffer | to write stream data from. |
len | of bytes to write to stream. |
timer | to wait for data in milliseconds. |
|
protectedinherited |
Set the total protocol stack network kernel buffer size for both send and receive together.
size | of buffer. |
|
staticinherited |
See if a specific protocol family is available in the current runtime environment.
void URLStream::close | ( | ) |
Close the URL stream for a new connection.
|
protectedinherited |
Create a TCP stream by connecting to a TCP socket (on a remote machine).
host | address of remote TCP server. |
port | number to connect. |
mss | maximum segment size of streaming buffers. |
|
protectedinherited |
Connect a TCP stream to a named destination host and port number, using getaddrinfo interface if available.
name | of host and service to connect |
mss | maximum segment size of stream buffer |
|
inherited |
Accept a connection from a TCP Server.
server | socket listening |
|
protectedinherited |
Used as a common handler for connection failure processing.
|
inherited |
Disconnect the current session and prepare for a new one.
|
protectedinherited |
Drop membership from a multicast group.
ia | address of multicast group to drop. |
|
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.
|
protectedinherited |
Used to terminate the buffer space and cleanup the socket connection.
This fucntion is called by the destructor.
|
protectedinherited |
This service is used to throw all socket errors which usually occur during the socket constructor.
error | defined socket error id. |
err | string or message to pass. |
systemError | the system error# that caused the error |
|
inlineprotectedinherited |
|
protectedvirtual |
A virtual to insert additional header info into the request.
Error URLStream::get | ( | const char * | url, |
size_t | buffer = 512 |
||
) |
Get URL data from a named stream of a known buffer size.
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.
buffer | size of buffer. |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
private |
Get the local address and port number this socket is currently bound to.
port | ptr to port number on local host. |
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.
port | ptr to NATed port number on local host. |
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.
port | ptr to port number of remote socket. |
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.
port | ptr to port number of sender. |
Reimplemented in DCCPSocket.
URLStream& URLStream::getline | ( | char * | buffer, |
size_t | len | ||
) |
Line parsing with conversion.
buffer | to store. |
len | maximum buffer size. |
|
inline |
|
inherited |
Get protocol segment size.
|
inherited |
Error URLStream::head | ( | const char * | url, |
size_t | buffer = 512 |
||
) |
Used to fetch header information for a resource.
url | name of resource. |
buffer | size of buffer. |
|
protectedvirtual |
Derived method to receive and parse http "headers".
header | keyword. |
value | header keyword value. |
|
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.
|
inlineinherited |
|
inherited |
|
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.
|
inlineinherited |
|
protectedinherited |
Join a multicast group.
ia | address of multicast group to join. |
|
inherited |
Operator based testing to see if a socket is currently active.
|
protectedinherited |
This streambuf method is used to write the output buffer through the established tcp connection.
ch | char to push through. |
|
inlineinherited |
Error URLStream::post | ( | const char * | url, |
const char ** | vars, | ||
size_t | buffer = 512 |
||
) |
Post URL vars with post method.
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.
url | name of resource being posted. |
form | multi-part resource. |
buffer | size to use. |
|
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.
buf | pointer to byte allocation. |
len | maximum length to read. |
separator | separator for a particular ASCII character |
t | timeout for pending data in milliseconds. |
|
protectedinherited |
Process a logical input line from a socket descriptor directly.
buf | pointer to string. |
len | maximum length to read. |
timeout | for pending data in milliseconds. |
|
protectedinherited |
Set the protocol stack network kernel receive buffer size associated with the socket.
size | of buffer in bytes. |
|
protectedinherited |
Set thr receive limit.
Receive timeout for receiving raw network data.
timer | value in milliseconds. |
|
protectedinherited |
Set the protocol stack network kernel send buffer size associated with the socket.
size | of buffer in bytes. |
|
protected |
Send http header to server.
url | base to send header to |
vars | to post or use in get method |
bufsize | of stream buffering to use |
|
protectedinherited |
Set the send limit.
Set the send timeout for sending raw network data.
timer | value in millisec. |
|
inline |
|
inline |
void URLStream::setAuthentication | ( | Authentication | a, |
const char * | str = NULL |
||
) |
Set authentication type for the url.
a | authentication. |
str | string. |
|
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.
enable | when set to true. |
|
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.
immediate | mode specify socket I/O call blocking mode. |
|
inline |
|
inlineprotectedinherited |
|
inline |
|
inline |
|
inherited |
Set the keep-alive status of this socket and if keep-alive messages will be sent.
enable | keep alive messages. |
|
inherited |
Enable lingering sockets on close.
linger | specify linger enable. |
|
inline |
Set the multicast loopback flag for the socket.
Loopback enables a socket to hear what it is sending.
enable | when set to true. |
family | of protocol. |
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.
enable | when set to true. |
family | of protocol. |
|
protectedinherited |
Enable/disable delaying packets (Nagle algorithm)
enable | disable Nagle algorithm when set to true. |
|
inline |
|
inline |
|
inline |
void URLStream::setProxy | ( | const char * | host, |
tpport_t | port | ||
) |
Set the proxy server used.
host | proxy host. |
port | proxy port. |
void URLStream::setProxyAuthentication | ( | Authentication | a, |
const char * | str = NULL |
||
) |
Set proxy authentication type for the url.
a | authentication. |
str | string. |
|
inline |
|
inline |
void URLStream::setReferer | ( | const char * | str | ) |
Set the referer url.
str | referer string. |
|
protectedinherited |
Set the socket routing to indicate if outgoing messages should bypass normal routing (set false).
enable | normal routing when set to true. |
|
inline |
Set the multicast time to live for a multicast socket.
ttl | time to live. |
fam | family of protocol. |
Set packet scheduling on platforms which support ip quality of service conventions.
This effects how packets in the queue are scheduled through the interface.
service | type of service enumerated type. |
|
inline |
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.
url | name of resource. |
vars | to set. |
buffer | size of buffer. |
|
inherited |
Flushes the stream input and output buffers, writes pending output.
|
inlineprotectedinherited |
|
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.
|
protected |
Called if stream buffer needs refilling.
|
protectedvirtualinherited |
Write a block of len bytes to socket.
buf | pointer to byte allocation. |
len | maximum length to write. |
t | timeout for pending data in milliseconds. |
|
related |
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.
src | source buffer |
dest | destination buffer. If NULL src is used |
|
related |
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).
src | source string |
dst | destination octet buffer |
dstsize | destination buffer size |
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).
src | source string |
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).
src | source string |
dst | destination octet buffer |
dstsize | destination buffer size |
|
related |
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.
source | source string |
dest | destination octet buffer |
size | destination buffer size |
|
related |
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).
src | source buffer |
srcsize | source buffer size |
dst | destination buffer |
dstsize | destination buffer size |
Encode a STL string using base64 coding into a STL string
src | source string |
Encode a octet stream using base64 coding into a STL string
src | source buffer |
srcsize | source buffer size |
|
related |
Decode an url parameter (ie "\%20" -> " ")
source | string |
dest | destination buffer. If NULL source is used |
|
related |
Encode an url parameter (ie " " -> "+")
source | string |
dest | destination buffer. Do not overlap with source |
size | destination buffer size. |
|
private |
struct { ... } Socket::flags |
|
private |
|
protectedinherited |