Library: RemotingNG/SOAP
Package: SOAP
Header: Poco/RemotingNG/SOAP/Listener.h
The RemotingNG Listener implementation for the SOAP transport.
Direct Base Classes: Poco::RemotingNG::Listener
All Base Classes: Poco::RefCountedObject, Poco::RemotingNG::Listener
Member Functions: createURI, enableChunkedTransferEncoding, enableCompression, enableMTOM, handlesURI, isChunkedTransferEncodingEnabled, isCompressionEnabled, isMTOMEnabled, protocol, registerObject, start, stop, unregisterObject
Inherited Functions: createURI, duplicate, endPoint, handlesURI, protocol, referenceCount, registerObject, release, start, stop, unregisterObject
typedef Poco::AutoPtr < Listener > Ptr;
Listener(
const std::string & endPoint,
Protocol proto
);
Creates a Listener for the given endpoint, which must be in <host>:<port> format.
The value specified for proto determines the URI scheme used by createURI().
Note that the Listener instance created by this constructor does not actually accept requests itself. It merely registers an endpoint in the ORB. A Poco::Net::HTTPServer must be created for accepting SOAP requests using a SOAPRequestHandler.
Listener(
const std::string & endPoint,
const std::string & wsdlPath,
Poco::Net::HTTPServerParams::Ptr pParams = new Poco::Net::HTTPServerParams
);
Creates a Listener for the given endpoint, which must be in <host>:<port> format.
This constructor will create a Poco::Net::HTTPServer instance for handling incoming SOAP requests, using a Poco::Net::ServerSocket bound to endPoint.
wsdlPath specifies the path to the directory containing WSDL documents. It can be empty if the WSDL documents are located in the current working directory.
Listener(
const std::string & endPoint,
const std::string & wsdlPath,
const Poco::Net::ServerSocket & socket,
Poco::Net::HTTPServerParams::Ptr pParams = new Poco::Net::HTTPServerParams
);
Creates a Listener for the given endpoint, which must be in <host>:<port> format.
This constructor will create a Poco::Net::HTTPServer instance using the given server socket for handling incoming SOAP requests. The given server socket can be a Poco::Net::ServerSocket or a Poco::Net::SecureServerSocket which must be bound to a socket address corresponding to the given endPoint.
wsdlPath specifies the path to the directory containing WSDL documents. It can be empty if the WSDL documents are located in the current working directory.
~Listener();
Destroys the Listener.
std::string createURI(
const Poco::RemotingNG::Identifiable::TypeId & typeId,
const Poco::RemotingNG::Identifiable::ObjectId & objectId
);
void enableChunkedTransferEncoding(
bool enable = true
);
Enables or disables chunked transfer encoding for responses. Default is enabled.
void enableCompression(
bool enable = true
);
Enables or disables GZIP compression for responses. Default is enabled.
Note that chunked transfer encoding must also be enabled in order to allow compression.
void enableMTOM(
bool enable = true
);
Enables or disables MTOM (Message Transport Optimization Mechanism) for server responses. If enabled, every response will be sent in a MIME multipart message and binary data (std::vector<char>) will be sent raw in a separate MIME part instead of Base64-encoded within the SOAP body.
See http://www.w3.org/TR/soap12-mtom/ for more information about MTOM.
bool handlesURI(
const std::string & uri
);
See also: Poco::RemotingNG::Listener::handlesURI()
bool isChunkedTransferEncodingEnabled() const;
Returns true if and only if chunked transfer encoding is enabled for responses.
bool isCompressionEnabled() const;
Returns true if and only if GZIP compression is enabled for responses.
bool isMTOMEnabled() const;
Returns true if and only if MTOM is enabled.
const std::string & protocol() const;
See also: Poco::RemotingNG::Listener::protocol()
void registerObject(
Poco::RemotingNG::RemoteObject::Ptr pRemoteObject,
Poco::RemotingNG::Skeleton::Ptr pSkeleton
);
void start();
See also: Poco::RemotingNG::Listener::start()
void stop();
See also: Poco::RemotingNG::Listener::stop()
void unregisterObject(
Poco::RemotingNG::RemoteObject::Ptr pRemoteObject
);