Ice 3.8
C++ API Reference
Loading...
Searching...
No Matches
Ice::Connection Class Referenceabstract

Represents a connection that uses the Ice protocol. More...

#include <Ice/Ice.h>

Public Member Functions

virtual void abort () noexcept=0
 Aborts this connection.
std::future< void > close ()
 Starts a graceful closure of this connection once all outstanding invocations have completed.
virtual void close (std::function< void()> response, std::function< void(std::exception_ptr)> exception) noexcept=0
 Starts a graceful closure of this connection once all outstanding invocations have completed.
template<typename Prx = ObjectPrx, std::enable_if_t< std::is_base_of_v< ObjectPrx, Prx >, bool > = true>
Prx createProxy (Identity id) const
 Creates a special proxy (a "fixed proxy") that always uses this connection.
void flushBatchRequests (CompressBatch compress)
 Flushes any pending batch requests for this connection.
std::future< void > flushBatchRequestsAsync (CompressBatch compress)
 Flushes any pending batch requests for this connection.
virtual std::function< void()> flushBatchRequestsAsync (CompressBatch compress, std::function< void(std::exception_ptr)> exception, std::function< void(bool)> sent=nullptr)=0
 Flushes any pending batch requests for this connection.
virtual ObjectAdapterPtr getAdapter () const noexcept=0
 Gets the object adapter associated with this connection.
virtual EndpointPtr getEndpoint () const noexcept=0
 Gets the endpoint from which the connection was created.
virtual ConnectionInfoPtr getInfo () const =0
 Returns the connection information.
virtual void setAdapter (const ObjectAdapterPtr &adapter)=0
 Associates an object adapter with this connection.
virtual void setBufferSize (int rcvSize, int sndSize)=0
 Sets the size of the receive and send buffers.
virtual void setCloseCallback (CloseCallback callback)=0
 Sets a close callback on the connection.
virtual void throwException () const =0
 Throws an exception that provides the reason for the closure of this connection.
virtual std::string toString () const =0
 Returns a description of the connection as human readable text, suitable for logging or error messages.
virtual const std::string & type () const noexcept=0
 Returns the connection type.

Detailed Description

Represents a connection that uses the Ice protocol.

Definition at line 50 of file Connection.h.


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