Poco::RemotingNG::TCP

class Transport

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

Description

The Transport implementation for RemotingNG TCP.

Inheritance

Direct Base Classes: Poco::RemotingNG::Transport

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

Member Summary

Member Functions: authenticate, beginMessage, beginRequest, connect, connected, disconnect, enableCompression, endPoint, endRequest, getAuthenticator, getCredentials, getTimeout, isCompressionEnabled, sendMessage, sendRequest, setAuthenticator, setCredentials, setTimeout, setupSerializer, verifyCredentials

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

Constructors

Transport

explicit Transport(
    ConnectionManager & connectionManager
);

Creates a Transport using the given ConnectionManager.

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
);

connected virtual

bool connected() const;

disconnect virtual

void disconnect();

enableCompression

void enableCompression(
    bool enable
);

Enables or disables zlib deflate compression for requests.

endPoint virtual

const std::string & endPoint() const;

endRequest virtual

void endRequest();

getAuthenticator

ClientAuthenticator::Ptr getAuthenticator() const;

Returns the ClientAuthenticator.

getCredentials

const Credentials & getCredentials() const;

Returns the credentials for authentication.

getTimeout

Poco::Timespan getTimeout() const;

Returns the response timeout.

isCompressionEnabled

bool isCompressionEnabled() const;

Returns true if and only if zlib deflate compression is enabled for requests. Default is disabled.

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
);

setAuthenticator

void setAuthenticator(
    ClientAuthenticator::Ptr pAuthenticator
);

Sets the ClientAuthenticator to be used for authentication.

setCredentials

void setCredentials(
    const Credentials & credentials
);

Sets the credentials for authentication.

setTimeout

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

Sets the response timeout.

authenticate protected

void authenticate();

setupSerializer protected

void setupSerializer(
    const Poco::RemotingNG::Identifiable::ObjectId & oid,
    const Poco::RemotingNG::Identifiable::TypeId & tid,
    Poco::RemotingNG::SerializerBase::MessageType messageType,
    Poco::UInt16 frameFlags
);

verifyCredentials protected static

static bool verifyCredentials(
    const Credentials & credentials
);

Variables

PROTOCOL static

static const std::string PROTOCOL;