Ice 3.7 C++98 API Reference
Loading...
Searching...
No Matches
Ice::EndpointInfo Class Referenceabstract

Base class providing access to the endpoint details. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::EndpointInfo:
Collaboration diagram for Ice::EndpointInfo:

Public Types

typedef EndpointInfoPtr PointerType

Public Member Functions

virtual bool datagram () const throw () =0
 Returns true if this endpoint is a datagram endpoint.
 EndpointInfo ()
 EndpointInfo (const ::Ice::EndpointInfoPtr &underlying, ::Ice::Int timeout, bool compress)
 One-shot constructor to initialize all data members.
virtual bool secure () const throw () =0
 Returns true if this endpoint is a secure endpoint.
virtual Short type () const throw () =0
 Returns the type of the endpoint.
virtual ~EndpointInfo ()
Public Member Functions inherited from Ice::LocalObject
virtual bool operator< (const LocalObject &) const
virtual bool operator== (const LocalObject &) const
Public Member Functions inherited from IceUtil::Shared
void __clearFlag (unsigned char flag)
virtual void __decRef ()
virtual int __getRef () const
bool __hasFlag (unsigned char flag)
virtual void __incRef ()
void __setFlag (unsigned char flag)
virtual void __setNoDelete (bool)
Sharedoperator= (const Shared &)
 Shared ()
 Shared (const Shared &)
virtual ~Shared ()

Public Attributes

bool compress
 Specifies whether or not compression should be used if available when using this endpoint.
::Ice::Int timeout
 The timeout for the endpoint in milliseconds.
::Ice::EndpointInfoPtr underlying
 The information of the underyling endpoint of null if there's no underlying endpoint.

Additional Inherited Members

Static Public Attributes inherited from IceUtil::Shared
static const unsigned char NoDelete
Protected Attributes inherited from IceUtil::Shared
unsigned char _flags
IceUtilInternal::Atomic _ref

Detailed Description

Base class providing access to the endpoint details.

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~EndpointInfo()

virtual Ice::EndpointInfo::~EndpointInfo ( )
virtual

Reimplemented in IceSSL::EndpointInfo.

◆ EndpointInfo() [1/2]

Ice::EndpointInfo::EndpointInfo ( )
inline

◆ EndpointInfo() [2/2]

Ice::EndpointInfo::EndpointInfo ( const ::Ice::EndpointInfoPtr & underlying,
::Ice::Int timeout,
bool compress )
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.

Member Function Documentation

◆ datagram()

virtual bool Ice::EndpointInfo::datagram ( ) const
throw ( )
pure virtual

Returns true if this endpoint is a datagram endpoint.

Returns
True for a datagram endpoint.

◆ secure()

virtual bool Ice::EndpointInfo::secure ( ) const
throw ( )
pure virtual

Returns true if this endpoint is a secure endpoint.

Returns
True for a secure endpoint.

◆ type()

virtual Short Ice::EndpointInfo::type ( ) const
throw ( )
pure virtual

Returns the type of the endpoint.

Returns
The endpoint type.

Member Data Documentation

◆ compress

bool Ice::EndpointInfo::compress

Specifies whether or not compression should be used if available when using this endpoint.

◆ timeout

::Ice::Int Ice::EndpointInfo::timeout

The timeout for the endpoint in milliseconds.

0 means non-blocking, -1 means no timeout.

◆ underlying

::Ice::EndpointInfoPtr Ice::EndpointInfo::underlying

The information of the underyling endpoint of null if there's no underlying endpoint.


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