Ice::EndpointInfo Class Reference

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

#include <Ice/Ice.h>

Inheritance diagram for Ice::EndpointInfo:

Public Member Functions
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
EndpointInfo &	operator= (const EndpointInfo &)=default
EndpointInfo &	operator= (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
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::EndpointInfo >	underlying
	The information of the underyling endpoint of null if there's no underlying endpoint. More...

Detailed Description

Base class providing access to the endpoint details.

Constructor & Destructor Documentation

~EndpointInfo()

virtual Ice::EndpointInfo::~EndpointInfo ( )

virtual

Reimplemented in IceSSL::EndpointInfo.

EndpointInfo() [1/4]

Ice::EndpointInfo::EndpointInfo ( )

default

EndpointInfo() [2/4]

Ice::EndpointInfo::EndpointInfo ( const EndpointInfo &  )

default

EndpointInfo() [3/4]

Ice::EndpointInfo::EndpointInfo ( EndpointInfo &&  )

default

EndpointInfo() [4/4]

Ice::EndpointInfo::EndpointInfo ( const ::std::shared_ptr<::Ice::EndpointInfo > &  underlying, int  timeout, bool  compress  )

inline

One-shot constructor to initialize all data members.

Parameters

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

Member Function Documentation

datagram()

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

pure virtualnoexcept

Returns true if this endpoint is a datagram endpoint.

Returns

True for a datagram endpoint.

operator=() [1/2]

EndpointInfo& Ice::EndpointInfo::operator= ( const EndpointInfo &  )

default

operator=() [2/2]

EndpointInfo& Ice::EndpointInfo::operator= ( EndpointInfo &&  )

default

secure()

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

pure virtualnoexcept

Returns true if this endpoint is a secure endpoint.

Returns

True for a secure endpoint.

type()

virtual short Ice::EndpointInfo::type ( ) const

pure virtualnoexcept

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

int Ice::EndpointInfo::timeout

The timeout for the endpoint in milliseconds.

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

underlying

::std::shared_ptr<::Ice::EndpointInfo> 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:

• generated/cpp11/x64/Release/Ice/Endpoint.h