Ice 3.7 C++11 API Reference
Public Member Functions | Public Attributes | List of all members
Ice::OpaqueEndpointInfo Class Reference

Provides access to the details of an opaque endpoint. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::OpaqueEndpointInfo:
Inheritance graph
[legend]
Collaboration diagram for Ice::OpaqueEndpointInfo:
Collaboration graph
[legend]

Public Member Functions

 OpaqueEndpointInfo ()=default
 
 OpaqueEndpointInfo (const ::std::shared_ptr<::Ice::EndpointInfo > &underlying, int timeout, bool compress, const ::Ice::EncodingVersion &rawEncoding, const ::Ice::ByteSeq &rawBytes)
 One-shot constructor to initialize all data members. More...
 
 OpaqueEndpointInfo (const OpaqueEndpointInfo &)=default
 
 OpaqueEndpointInfo (OpaqueEndpointInfo &&)=default
 
OpaqueEndpointInfooperator= (const OpaqueEndpointInfo &)=default
 
OpaqueEndpointInfooperator= (OpaqueEndpointInfo &&)=default
 
virtual ~OpaqueEndpointInfo ()
 
- Public Member Functions inherited from Ice::EndpointInfo
virtual bool datagram () const noexcept=0
 Returns true if this endpoint is a datagram endpoint. More...
 
 EndpointInfo ()=default
 
 EndpointInfo (const ::std::shared_ptr<::Ice::EndpointInfo > &underlying, int timeout, bool compress)
 One-shot constructor to initialize all data members. More...
 
 EndpointInfo (const EndpointInfo &)=default
 
 EndpointInfo (EndpointInfo &&)=default
 
EndpointInfooperator= (const EndpointInfo &)=default
 
EndpointInfooperator= (EndpointInfo &&)=default
 
virtual bool secure () const noexcept=0
 Returns true if this endpoint is a secure endpoint. More...
 
virtual short type () const noexcept=0
 Returns the type of the endpoint. More...
 
virtual ~EndpointInfo ()
 

Public Attributes

::Ice::ByteSeq rawBytes
 The raw encoding of the opaque endpoint. More...
 
::Ice::EncodingVersion rawEncoding
 The encoding version of the opaque endpoint (to decode or encode the rawBytes). More...
 
- Public Attributes inherited from Ice::EndpointInfo
bool compress
 Specifies whether or not compression should be used if available when using this endpoint. More...
 
int timeout
 The timeout for the endpoint in milliseconds. More...
 
::std::shared_ptr<::Ice::EndpointInfounderlying
 The information of the underyling endpoint of null if there's no underlying endpoint. More...
 

Detailed Description

Provides access to the details of an opaque endpoint.

See also
Endpoint

Constructor & Destructor Documentation

◆ ~OpaqueEndpointInfo()

virtual Ice::OpaqueEndpointInfo::~OpaqueEndpointInfo ( )
virtual

◆ OpaqueEndpointInfo() [1/4]

Ice::OpaqueEndpointInfo::OpaqueEndpointInfo ( )
default

◆ OpaqueEndpointInfo() [2/4]

Ice::OpaqueEndpointInfo::OpaqueEndpointInfo ( const OpaqueEndpointInfo )
default

◆ OpaqueEndpointInfo() [3/4]

Ice::OpaqueEndpointInfo::OpaqueEndpointInfo ( OpaqueEndpointInfo &&  )
default

◆ OpaqueEndpointInfo() [4/4]

Ice::OpaqueEndpointInfo::OpaqueEndpointInfo ( const ::std::shared_ptr<::Ice::EndpointInfo > &  underlying,
int  timeout,
bool  compress,
const ::Ice::EncodingVersion rawEncoding,
const ::Ice::ByteSeq rawBytes 
)
inline

One-shot constructor to initialize all data members.

Parameters
underlyingThe information of the underyling endpoint of null if there's no underlying endpoint.
timeoutThe timeout for the endpoint in milliseconds.
compressSpecifies whether or not compression should be used if available when using this endpoint.
rawEncodingThe encoding version of the opaque endpoint (to decode or encode the rawBytes).
rawBytesThe raw encoding of the opaque endpoint.

Member Function Documentation

◆ operator=() [1/2]

OpaqueEndpointInfo& Ice::OpaqueEndpointInfo::operator= ( const OpaqueEndpointInfo )
default

◆ operator=() [2/2]

OpaqueEndpointInfo& Ice::OpaqueEndpointInfo::operator= ( OpaqueEndpointInfo &&  )
default

Member Data Documentation

◆ rawBytes

::Ice::ByteSeq Ice::OpaqueEndpointInfo::rawBytes

The raw encoding of the opaque endpoint.

◆ rawEncoding

::Ice::EncodingVersion Ice::OpaqueEndpointInfo::rawEncoding

The encoding version of the opaque endpoint (to decode or encode the rawBytes).


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