Poco::RemotingNG::JSONRPC

class Transport

File Information

Library: RemotingNG/JSONRPC
Package: JSONRPC
Header: Poco/RemotingNG/JSONRPC/Transport.h

Description

The Transport implementation for RemotingNG JSONRPC.

This transport implements the JSON-RPC 2.0 protocol (see <http://www.jsonrpc.org/specification> for the specification).

Parameters are always passed by-name through an object, passing by position (array) is not supported. Furthermore, batched requests are not supported.

The transport supports HTTP Basic and HTTP Digest authentication. Please note that for HTTP Digest authentication to work, chunked transfer encoding must be disabled. Also, HTTP Digest authentication is not supported for one-way requests.

Inheritance

Direct Base Classes: Poco::RemotingNG::Transport

All Base Classes: Poco::RefCountedObject, Poco::RemotingNG::AttributedObject, Poco::RemotingNG::Transport

Member Summary

Member Functions: beginMessage, beginRequest, connect, connected, disconnect, enableChunkedTransferEncoding, enableCompression, enableKeepAlive, endPoint, endRequest, getAuthentication, getCookieStore, getCredentials, getKeepAliveTimeout, getPassword, getProxyConfig, getTimeout, getUserAgent, getUsername, httpSessionFactory, isChunkedTransferEncodingEnabled, isCompressionEnabled, isKeepAliveEnabled, prepareRequest, requireSession, sendMessage, sendRequest, setAuthentication, setCookieStore, setCredentials, setKeepAliveTimeout, setPassword, setProxyConfig, setTimeout, setUserAgent, setUsername

Inherited Functions: beginMessage, beginRequest, clearAttributes, connect, connected, countAttributes, disconnect, duplicate, endPoint, endRequest, enumerateAttributes, getAttribute, hasAttribute, lock, operator =, referenceCount, release, removeAttribute, sendMessage, sendRequest, setAttribute, unlock

Enumerations

AuthMode

Authentication mode.

AUTH_NONE = 0

No authentication.

AUTH_BASIC = 1

HTTP Basic Authentication only (credentials are always sent).

AUTH_DIGEST = 2

HTTP Digest Authentication only.

AUTH_ANY = 3

HTTP Basic or Digest authentication (whichever the server requests).

Constructors

Transport

Transport();

Creates a Transport for JSON-RPC 2.0.

Destructor

~Transport virtual

~Transport();

Destroys the Transport.

Member Functions

beginMessage

Poco::RemotingNG::Serializer & beginMessage(
    const Poco::RemotingNG::Identifiable::ObjectId & oid,
    const Poco::RemotingNG::Identifiable::TypeId & tid,
    const std::string & messageName,
    Poco::RemotingNG::SerializerBase::MessageType messageType
);

beginRequest

Poco::RemotingNG::Serializer & beginRequest(
    const Poco::RemotingNG::Identifiable::ObjectId & oid,
    const Poco::RemotingNG::Identifiable::TypeId & tid,
    const std::string & messageName,
    Poco::RemotingNG::SerializerBase::MessageType messageType
);

connect virtual

void connect(
    const std::string & endPoint
);

See also: Poco::RemotingNG::Transport::connect()

connected virtual

bool connected() const;

See also: Poco::RemotingNG::Transport::connected()

disconnect virtual

void disconnect();

See also: Poco::RemotingNG::Transport::disconnect()

enableChunkedTransferEncoding

void enableChunkedTransferEncoding(
    bool enable = true
);

Enables or disables chunked transfer encoding for HTTP requests. This is normally enabled. However, some poorly implemented HTTP stacks cannot handle chunked HTTP messages. Also, chunked transfer encoding must be disabled if AUTH_DIGEST or AUTH_ANY authentication is used.

Regardless of this setting, chunked transfer encoding is always supported for responses sent by the server.

enableCompression

void enableCompression(
    bool enable
);

Enables or disables HTTP compression via GZIP Content-Encoding for requests. This is normally disabled, due to a lack of support by most servers.

Note that chunked transfer encoding must also be enabled in order to allow compression.

Regardless of this setting, server responses can always be compressed using GZIP Content-Encoding.

enableKeepAlive

void enableKeepAlive(
    bool enable
);

Enables or disables HTTP/1.1 persistent connections.

The Transport must be connected, otherwise a Poco::IllegalStateException will be thrown.

endPoint virtual

const std::string & endPoint() const;

See also: Poco::RemotingNG::Transport::endPoint()

endRequest virtual

void endRequest();

See also: Poco::RemotingNG::Transport::endRequest()

getAuthentication

AuthMode getAuthentication() const;

Returns the authentication mode.

getCookieStore

CookieStore::Ptr getCookieStore() const;

Returns the CookieStore.

getCredentials

Credentials getCredentials() const;

Returns the credentials, containing username and password attributes.

getKeepAliveTimeout

Poco::Timespan getKeepAliveTimeout() const;

Returns the timeout for HTTP/1.1 persistent connections.

The Transport must be connected, otherwise a Poco::IllegalStateException will be thrown.

getPassword

const std::string & getPassword() const;

Deprecated. This function issc_deprecated.

Returns the password for HTTP authentication.

This method is deprecated and may be removed in a future version. Code should be changed to use getCredentials() instead.

getProxyConfig

const Poco::Net::HTTPClientSession::ProxyConfig & getProxyConfig() const;

Returns the proxy configuration.

getTimeout

Poco::Timespan getTimeout() const;

Returns the HTTP timeout.

The Transport must be connected, otherwise a Poco::IllegalStateException will be thrown.

getUserAgent

const std::string & getUserAgent() const;

Returns the value of the User-Agent header sent with JSON-RPC HTTP requests, or an empty string if no User-Agent value has been set.

getUsername

const std::string & getUsername() const;

Deprecated. This function issc_deprecated.

Returns the username for HTTP authentication.

This method is deprecated and may be removed in a future version. Code should be changed to use getCredentials() instead.

httpSessionFactory static inline

static Poco::Net::HTTPSessionFactory & httpSessionFactory();

Returns the Poco::Net::HTTPSessionFactory instance used by the transport.

isChunkedTransferEncodingEnabled

bool isChunkedTransferEncodingEnabled() const;

Returns true iff chunked transfer encoding is enabled, which is the default unless enableChunkedTransferEncoding(false) has been called.

isCompressionEnabled

bool isCompressionEnabled() const;

Returns true iff HTTP compression (GZIP) is enabled for requests. Default is disabled.

isKeepAliveEnabled

bool isKeepAliveEnabled() const;

Returns true iff HTTP/1.1 persistent connections are enabled.

The Transport must be connected, otherwise a Poco::IllegalStateException will be thrown.

sendMessage

void sendMessage(
    const Poco::RemotingNG::Identifiable::ObjectId & oid,
    const Poco::RemotingNG::Identifiable::TypeId & tid,
    const std::string & messageName,
    Poco::RemotingNG::SerializerBase::MessageType messageType
);

sendRequest

Poco::RemotingNG::Deserializer & sendRequest(
    const Poco::RemotingNG::Identifiable::ObjectId & oid,
    const Poco::RemotingNG::Identifiable::TypeId & tid,
    const std::string & messageName,
    Poco::RemotingNG::SerializerBase::MessageType messageType
);

setAuthentication

void setAuthentication(
    AuthMode authMode
);

Sets the authentication mode.

Please note that for AUTH_DIGEST or AUTH_ANY, chunked transfer encoding must be disabled.

setCookieStore

void setCookieStore(
    CookieStore::Ptr pCookieStore
);

Sets the CookieStore.

setCredentials

void setCredentials(
    const Credentials & creds
);

Sets the credentials for client authentication.

The Credentials object should contain a username (Credentials::ATTR_USERNAME, "n") and a password (Credentials::ATTR_PASSWORD, "p") attribute.

setKeepAliveTimeout

void setKeepAliveTimeout(
    const Poco::Timespan & timeout
);

Sets the timeout for HTTP/1.1 persistent connections.

The Transport must be connected, otherwise a Poco::IllegalStateException will be thrown.

setPassword

void setPassword(
    const std::string & password
);

Deprecated. This function issc_deprecated.

Sets the password for HTTP authentication.

This method is deprecated and may be removed in a future version. Code should be changed to use setCredentials() instead.

setProxyConfig

void setProxyConfig(
    const Poco::Net::HTTPClientSession::ProxyConfig & proxyConfig
);

Sets the proxy configuration.

setTimeout

void setTimeout(
    const Poco::Timespan & timeout
);

Sets the HTTP timeout.

The Transport must be connected, otherwise a Poco::IllegalStateException will be thrown.

setUserAgent

void setUserAgent(
    const std::string & userAgent
);

Sets the value of the User-Agent header sent with JSON-RPC HTTP requests. If an empty string is given (default), no User-Agent header is included in the request.

setUsername

void setUsername(
    const std::string & username
);

Deprecated. This function issc_deprecated.

Sets the username for HTTP authentication.

This method is deprecated and may be removed in a future version. Code should be changed to use setCredentials() instead.

prepareRequest protected

void prepareRequest(
    Poco::Net::HTTPRequest & request,
    const std::string & messageName
);

requireSession protected

const Poco::Net::HTTPClientSession & requireSession() const;

requireSession protected

Poco::Net::HTTPClientSession & requireSession();

Variables

CONTENT_TYPE static

static const std::string CONTENT_TYPE;

PROTOCOL static

static const std::string PROTOCOL;

USER_AGENT protected static

static const std::string USER_AGENT;