Qore Programming Language  0.8.7
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions | List of all members
QoreHTTPClient Class Reference

provides a way to communicate with HTTP servers using Qore data structures More...

#include <QoreHTTPClient.h>

Inheritance diagram for QoreHTTPClient:
Inheritance graph
[legend]
Collaboration diagram for QoreHTTPClient:
Collaboration graph
[legend]

Public Member Functions

DLLEXPORT QoreHTTPClient ()
 creates the QoreHTTPClient object
 
virtual DLLEXPORT ~QoreHTTPClient ()
 destroys the object and frees all associated memory
 
DLLEXPORT int setOptions (const QoreHashNode *opts, ExceptionSink *xsink)
 set options with a hash, returns -1 if an exception was thrown, 0 for OK
 
DLLEXPORT void setDefaultPort (int prt)
 sets the default port
 
DLLEXPORT void setDefaultPath (const char *pth)
 sets the default path
 
DLLEXPORT void addProtocol (const char *prot, int port, bool ssl=false)
 adds a protocol
 
DLLEXPORT void setTimeout (int to)
 sets the connection and response packet timeout value in milliseconds
 
DLLEXPORT int getTimeout () const
 returns the connection and response packet timeout value in milliseconds
 
DLLEXPORT void setEncoding (const QoreEncoding *qe)
 sets the default encoding for the object
 
DLLEXPORT const QoreEncodinggetEncoding () const
 returns the default encoding for the object
 
DLLEXPORT int setHTTPVersion (const char *version, ExceptionSink *xsink)
 sets the http version from a string
 
DLLEXPORT const char * getHTTPVersion () const
 returns the http version as a string (either "1.0" or "1.1")
 
DLLEXPORT void setHTTP11 (bool h11)
 sets or clears HTTP 1.1 protocol compliance
 
DLLEXPORT bool isHTTP11 () const
 returns true if HTTP 1.1 protocol compliance has been set
 
DLLEXPORT int setURL (const char *url, ExceptionSink *xsink)
 sets the connection URL
 
DLLEXPORT QoreStringNodegetURL ()
 returns the connection parameters as a URL, caller owns the reference count returned
 
DLLEXPORT void setUserPassword (const char *user, const char *pass)
 sets the username and password for the connection
 
DLLEXPORT void clearUserPassword ()
 clears the username and password for the connection
 
DLLEXPORT int setProxyURL (const char *proxy, ExceptionSink *xsink)
 sets the proxy URL
 
DLLEXPORT QoreStringNodegetProxyURL ()
 returns the proxy connection parameters as a URL (or 0 if there is none), caller owns the reference count returned
 
DLLEXPORT void clearProxyURL ()
 clears the proxy URL
 
DLLEXPORT void setProxyUserPassword (const char *user, const char *pass)
 sets the username and password for the proxy connection
 
DLLEXPORT void clearProxyUserPassword ()
 clears the username and password for the proxy connection
 
DLLEXPORT void setSecure (bool is_secure)
 sets the SSL flag for use in the next connection
 
DLLEXPORT bool isSecure () const
 returns the SSL connection parameter flag
 
DLLEXPORT void setProxySecure (bool is_secure)
 sets the SSL flag for use in the next connection to the proxy
 
DLLEXPORT bool isProxySecure () const
 returns the SSL proxy connection parameter flag
 
DLLEXPORT void setMaxRedirects (int max)
 sets the max_redirects option
 
DLLEXPORT int getMaxRedirects () const
 returns the value of the max_redirects option
 
DLLEXPORT long verifyPeerCertificate ()
 returns the peer certificate verification code if an SSL connection is in progress
 
DLLEXPORT const char * getSSLCipherName ()
 returns the name of the SSL Cipher for the currently-connected control connection, or 0 if there is none
 
DLLEXPORT const char * getSSLCipherVersion ()
 returns the version string of the SSL Cipher for the currently-connected control connection, or 0 if there is none
 
DLLEXPORT int connect (ExceptionSink *xsink)
 opens a connection and returns a code giving the result
 
DLLEXPORT void disconnect ()
 disconnects from the remote server
 
DLLEXPORT QoreHashNodesend (const char *meth, const char *path, const QoreHashNode *headers, const void *data, unsigned size, bool getbody, QoreHashNode *info, ExceptionSink *xsink)
 sends a message to the remote server and returns the entire response as a hash, caller owns the QoreHashNode reference returned
 
DLLEXPORT AbstractQoreNodeget (const char *path, const QoreHashNode *headers, QoreHashNode *info, ExceptionSink *xsink)
 sends an HTTP "GET" method and returns the value of the message body returned, the caller owns the AbstractQoreNode reference returned
 
DLLEXPORT QoreHashNodehead (const char *path, const QoreHashNode *headers, QoreHashNode *info, ExceptionSink *xsink)
 sends an HTTP "HEAD" method and returns the headers returned, the caller owns the QoreHashNode reference returned
 
DLLEXPORT AbstractQoreNodepost (const char *path, const QoreHashNode *headers, const void *data, unsigned size, QoreHashNode *info, ExceptionSink *xsink)
 sends an HTTP "POST" message to the remote server and returns the message body of the response, caller owns the AbstractQoreNode reference returned
 
DLLEXPORT void setDefaultHeaderValue (const char *header, const char *val)
 sets the value of a default header to send with every outgoing message
 
virtual DLLEXPORT void deref (ExceptionSink *xsink)
 decrements the reference count and deletes the object when it reaches 0
 
DLLEXPORT void setConnectTimeout (int ms)
 sets the connect timeout in ms
 
DLLEXPORT int getConnectTimeout () const
 returns the connect timeout in ms, negative numbers mean no timeout
 
DLLEXPORT int setNoDelay (bool nodelay)
 sets the TCP_NODELAY flag on the object
 
DLLEXPORT void setEventQueue (Queue *cbq, ExceptionSink *xsink)
 sets the event queue, must be already referenced before call
 
DLLEXPORT bool getNoDelay () const
 returns the value of the TCP_NODELAY flag on the object
 
DLLEXPORT bool isConnected () const
 returns the connection status of the object
 
DLLEXPORT QoreHashNodegetPeerInfo (ExceptionSink *xsink) const
 returns peer information for a connected socket
 
DLLEXPORT QoreHashNodegetSocketInfo (ExceptionSink *xsink) const
 returns information for the current socket; the socket must be open
 
- Public Member Functions inherited from AbstractPrivateData
DLLLOCAL void ref ()
 increments the reference count of the object
 
virtual DLLLOCAL void deref ()
 decrements the reference count of the object without the possibility of throwing a Qore-language exception
 
- Public Member Functions inherited from QoreReferenceCounter
DLLEXPORT QoreReferenceCounter ()
 creates the reference counter object
 
DLLEXPORT ~QoreReferenceCounter ()
 destroys the reference counter object
 
DLLLOCAL int reference_count () const
 gets the reference count
 
DLLLOCAL bool is_unique () const
 returns true if the reference count is 1
 
DLLEXPORT void ROreference () const
 atomically increments the reference count
 
DLLEXPORT bool ROdereference () const
 atomically decrements the reference count
 

Additional Inherited Members

- Protected Member Functions inherited from AbstractPrivateData
virtual DLLLOCAL ~AbstractPrivateData ()
 as these objects are reference counted, the destructor should be called only when the reference count = 0 and not manually
 
- Protected Attributes inherited from QoreReferenceCounter
QoreThreadLock mRO
 pthread lock to ensure atomicity of updates for architectures where we don't have an atomic increment and decrement implementation
 

Detailed Description

provides a way to communicate with HTTP servers using Qore data structures

thread-safe, uses QoreSocket for socket communication

Member Function Documentation

DLLEXPORT void QoreHTTPClient::addProtocol ( const char *  prot,
int  port,
bool  ssl = false 
)

adds a protocol

useful for c++ derived classes

DLLEXPORT int QoreHTTPClient::connect ( ExceptionSink xsink)

opens a connection and returns a code giving the result

Returns
-1 if an exception was thrown, 0 for OK
virtual DLLEXPORT void QoreHTTPClient::deref ( ExceptionSink xsink)
virtual

decrements the reference count and deletes the object when it reaches 0

Parameters
xsinkif an error occurs, the Qore-language exception information will be added here

Reimplemented from AbstractPrivateData.

DLLEXPORT AbstractQoreNode* QoreHTTPClient::get ( const char *  path,
const QoreHashNode headers,
QoreHashNode info,
ExceptionSink xsink 
)

sends an HTTP "GET" method and returns the value of the message body returned, the caller owns the AbstractQoreNode reference returned

if you need to get all the headers received, then use QoreHTTPClient::send() instead

Parameters
paththe path string to send in the header
headersa hash of headers to add to the message
infoif not 0 then additional information about the HTTP communication will be added to the hash (key-value pairs), keys "headers", and optionally "redirect-#", "redirect-message-#" (where # is substituted with the redirect sequence number), and "chunked" (boolean, present only if the response was chunked)
xsinkif an error occurs, the Qore-language exception information will be added here
Returns
the body of the response message, caller owns the QoreHashNode reference returned (0 if there was an error or no body returned)
DLLEXPORT int QoreHTTPClient::getConnectTimeout ( ) const

returns the connect timeout in ms, negative numbers mean no timeout

Returns
the connect timeout in ms, negative numbers mean no timeout
DLLEXPORT const char* QoreHTTPClient::getHTTPVersion ( ) const

returns the http version as a string (either "1.0" or "1.1")

Returns
the http version as a string (either "1.0" or "1.1")
DLLEXPORT QoreHashNode* QoreHTTPClient::getPeerInfo ( ExceptionSink xsink) const

returns peer information for a connected socket

if the socket is not connected, a Qore-language exception is thrown

Parameters
xsinkif an error occurs, the Qore-language exception information will be added here
Returns
a hash with the following keys:
  • hostname: the hostname of the remote end (if known or appropriate for the socket type)
  • hostname_desc: a descriptive string for the remote hostname (including the socket type - ie "ipv6[host]")
  • address: the address of the remote end - for UNIX sockets this is the file path
  • address_desc: a descriptive string for the remote address
  • port: the port number if known
  • family: the address family (ie AF_INET, AF_INET6, AF_UNIX, ...)
  • familystr: a string description of the address family ("ipv4", "ipv6", etc)
DLLEXPORT QoreStringNode* QoreHTTPClient::getProxyURL ( )

returns the proxy connection parameters as a URL (or 0 if there is none), caller owns the reference count returned

Returns
the proxy connection parameters as a URL, caller owns the reference count returned
DLLEXPORT QoreHashNode* QoreHTTPClient::getSocketInfo ( ExceptionSink xsink) const

returns information for the current socket; the socket must be open

if the socket is not open, a Qore-language exception is thrown

Parameters
xsinkif an error occurs, the Qore-language exception information will be added here
Returns
a hash with the following keys:
  • hostname: the hostname for the local interface (if known or appropriate for the socket type)
  • hostname_desc: a descriptive string for the local hostname (including the socket type - ie "ipv6[host]")
  • address: the address of the local interface - for UNIX sockets this is the file path
  • address_desc: a descriptive string for the local interface
  • port: the port number if known
  • family: the address family (ie AF_INET, AF_INET6, AF_UNIX, ...)
  • familystr: a string description of the address family ("ipv4", "ipv6", etc)
DLLEXPORT const char* QoreHTTPClient::getSSLCipherName ( )

returns the name of the SSL Cipher for the currently-connected control connection, or 0 if there is none

Returns
the name of the SSL Cipher for the currently-connected control connection, or 0 if there is none
DLLEXPORT const char* QoreHTTPClient::getSSLCipherVersion ( )

returns the version string of the SSL Cipher for the currently-connected control connection, or 0 if there is none

Returns
the version string of the SSL Cipher for the currently-connected control connection, or 0 if there is none
DLLEXPORT QoreStringNode* QoreHTTPClient::getURL ( )

returns the connection parameters as a URL, caller owns the reference count returned

Returns
the connection parameters as a URL, caller owns the reference count returned
DLLEXPORT QoreHashNode* QoreHTTPClient::head ( const char *  path,
const QoreHashNode headers,
QoreHashNode info,
ExceptionSink xsink 
)

sends an HTTP "HEAD" method and returns the headers returned, the caller owns the QoreHashNode reference returned

Parameters
paththe path string to send in the header
headersa hash of headers to add to the message
infoif not 0 then additional information about the HTTP communication will be added to the hash (key-value pairs), keys "headers", and optionally "redirect-#", "redirect-message-#" (where # is substituted with the redirect sequence number), and "chunked" (boolean, present only if the response was chunked)
xsinkif an error occurs, the Qore-language exception information will be added here
Returns
the entire response as a hash, caller owns the QoreHashNode reference returned (0 if there was an error)
DLLEXPORT AbstractQoreNode* QoreHTTPClient::post ( const char *  path,
const QoreHashNode headers,
const void *  data,
unsigned  size,
QoreHashNode info,
ExceptionSink xsink 
)

sends an HTTP "POST" message to the remote server and returns the message body of the response, caller owns the AbstractQoreNode reference returned

possible errors: method not recognized, redirection errors, socket communication errors, timeout errors

Parameters
paththe path string to send in the header
headersa hash of headers to add to the message
dataoptional data to send (should not be 0 for a POST)
sizethe byte length of the data to send (if this is 0 then no data is sent)
infoif not 0 then additional information about the HTTP communication will be added to the hash (key-value pairs), keys "headers", and optionally "redirect-#", "redirect-message-#" (where # is substituted with the redirect sequence number), and "chunked" (boolean, present only if the response was chunked)
xsinkif an error occurs, the Qore-language exception information will be added here
Returns
the body of the response message, caller owns the QoreHashNode reference returned (0 if there was an error or no body returned)
DLLEXPORT QoreHashNode* QoreHTTPClient::send ( const char *  meth,
const char *  path,
const QoreHashNode headers,
const void *  data,
unsigned  size,
bool  getbody,
QoreHashNode info,
ExceptionSink xsink 
)

sends a message to the remote server and returns the entire response as a hash, caller owns the QoreHashNode reference returned

possible errors: method not recognized, redirection errors, socket communication errors, timeout errors

Parameters
meththe HTTP method name to send
paththe path string to send in the header
headersa hash of headers to add to the message
dataoptional data to send (may be 0)
sizethe byte length of the data to send (if this is 0 then no data is sent)
getbodyif true then a body will be read even if there is no "Content-Length:" header
infoif not 0 then additional information about the HTTP communication will be added to the hash (key-value pairs), keys "headers", and optionally "redirect-#", "redirect-message-#" (where # is substituted with the redirect sequence number), and "chunked" (boolean, present only if the response was chunked)
xsinkif an error occurs, the Qore-language exception information will be added here
Returns
the entire response as a hash, caller owns the QoreHashNode reference returned (0 if there was an error)
DLLEXPORT void QoreHTTPClient::setConnectTimeout ( int  ms)

sets the connect timeout in ms

Parameters
msconnect timeout in ms
DLLEXPORT void QoreHTTPClient::setDefaultHeaderValue ( const char *  header,
const char *  val 
)

sets the value of a default header to send with every outgoing message

Parameters
headerthe name of the header to send
valthe string value to use in the HTTP header
DLLEXPORT void QoreHTTPClient::setDefaultPath ( const char *  pth)

sets the default path

useful for c++ derived classes

DLLEXPORT void QoreHTTPClient::setDefaultPort ( int  prt)

sets the default port

useful for c++ derived classes

DLLEXPORT void QoreHTTPClient::setHTTP11 ( bool  h11)

sets or clears HTTP 1.1 protocol compliance

Parameters
h11if true sets HTTP 1.1 protocol compliance, if false set 1.0
DLLEXPORT int QoreHTTPClient::setHTTPVersion ( const char *  version,
ExceptionSink xsink 
)

sets the http version from a string

Parameters
versioneither "1.0" or "1.1"
xsinkif an error occurs, the Qore-language exception information will be added here
Returns
-1 if an exception was thrown, 0 for OK
DLLEXPORT int QoreHTTPClient::setNoDelay ( bool  nodelay)

sets the TCP_NODELAY flag on the object

This function will try to set the TCP_NODELAY flag immediately if the socket is connected, otherwise will it set a flag and the TCP_NODELAY option will be set on the next connection. If an error occurs setting TCP_NODELAY on a connected socket, then this function will return a non-zero value, and errno will be set

Parameters
nodelay0=turn off TCP_NODELAY, non-zero=turn on TCP_NODELAY
Returns
0=OK, non-zero means an error occured, errno is set
DLLEXPORT int QoreHTTPClient::setOptions ( const QoreHashNode opts,
ExceptionSink xsink 
)

set options with a hash, returns -1 if an exception was thrown, 0 for OK

options are:

  • protocols: a hash where each key is a protocol name and the value must be set to a integer giving a port number or a hash having the following keys:
  • port: giving the port number
  • ssl: giving a boolean true or false value
  • max_redirects: sets the max_redirects option
  • default_port: sets the default port number
  • proxy: sets the proxy URL
  • url: sets the default connection URL
  • default_path: sets the default path
  • timeout: sets the connection or response packet timeout value in milliseconds
  • http_version: either "1.0" or "1.1" to set the default HTTP version to use
  • connect_timeout: an integer giving the timeout value for new socket connections in milliseconds
    Note
    this function is unlocked and designed only to be called with the constructor
    Parameters
    optsthe options to set for the object
    xsinkif an error occurs, the Qore-language exception information will be added here
    Returns
    -1 if an exception was thrown, 0 for OK
DLLEXPORT int QoreHTTPClient::setProxyURL ( const char *  proxy,
ExceptionSink xsink 
)

sets the proxy URL

Parameters
proxythe URL to use for connection to the proxy
xsinkif an error occurs, the Qore-language exception information will be added here
Returns
-1 if an exception was thrown, 0 for OK
DLLEXPORT void QoreHTTPClient::setProxyUserPassword ( const char *  user,
const char *  pass 
)

sets the username and password for the proxy connection

Parameters
userthe username to set
passthe password to set
Note
these settings will only take effect if a proxy URL is set, so it only makes sense to call this function after setProxyURL(); also setProxyURL() will overwrite any settings here.
DLLEXPORT int QoreHTTPClient::setURL ( const char *  url,
ExceptionSink xsink 
)

sets the connection URL

Parameters
urlthe URL to use for connection parameters
xsinkif an error occurs, the Qore-language exception information will be added here
Returns
-1 if an exception was thrown, 0 for OK
DLLEXPORT void QoreHTTPClient::setUserPassword ( const char *  user,
const char *  pass 
)

sets the username and password for the connection

Parameters
userthe username to set
passthe password to set
Note
setURL() will overwrite any settings set here

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