Ice 3.7 C++11 API Reference
Loading...
Searching...
No Matches
Ice::IPEndpointInfo Class Reference

Provides access to the address details of a IP endpoint. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::IPEndpointInfo:
Collaboration diagram for Ice::IPEndpointInfo:

Public Member Functions

 IPEndpointInfo ()=default
 IPEndpointInfo (const ::std::shared_ptr<::Ice::EndpointInfo > &underlying, int timeout, bool compress, const ::std::string &host, int port, const ::std::string &sourceAddress)
 One-shot constructor to initialize all data members.
 IPEndpointInfo (const IPEndpointInfo &)=default
 IPEndpointInfo (IPEndpointInfo &&)=default
IPEndpointInfooperator= (const IPEndpointInfo &)=default
IPEndpointInfooperator= (IPEndpointInfo &&)=default
virtual ~IPEndpointInfo ()
Public Member Functions inherited from Ice::EndpointInfo
virtual bool datagram () const noexcept=0
 Returns true if this endpoint is a datagram endpoint.
 EndpointInfo ()=default
 EndpointInfo (const ::std::shared_ptr<::Ice::EndpointInfo > &underlying, int timeout, bool compress)
 One-shot constructor to initialize all data members.
 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.
virtual short type () const noexcept=0
 Returns the type of the endpoint.
virtual ~EndpointInfo ()

Public Attributes

::std::string host
 The host or address configured with the endpoint.
int port
 The port number.
::std::string sourceAddress
 The source IP address.
Public Attributes inherited from Ice::EndpointInfo
bool compress
 Specifies whether or not compression should be used if available when using this endpoint.
int timeout
 The timeout for the endpoint in milliseconds.
::std::shared_ptr<::Ice::EndpointInfounderlying
 The information of the underyling endpoint of null if there's no underlying endpoint.

Detailed Description

Provides access to the address details of a IP endpoint.

See also
Endpoint

Constructor & Destructor Documentation

◆ ~IPEndpointInfo()

virtual Ice::IPEndpointInfo::~IPEndpointInfo ( )
virtual

◆ IPEndpointInfo() [1/4]

Ice::IPEndpointInfo::IPEndpointInfo ( )
default

◆ IPEndpointInfo() [2/4]

Ice::IPEndpointInfo::IPEndpointInfo ( const IPEndpointInfo & )
default

◆ IPEndpointInfo() [3/4]

Ice::IPEndpointInfo::IPEndpointInfo ( IPEndpointInfo && )
default

◆ IPEndpointInfo() [4/4]

Ice::IPEndpointInfo::IPEndpointInfo ( const ::std::shared_ptr<::Ice::EndpointInfo > & underlying,
int timeout,
bool compress,
const ::std::string & host,
int port,
const ::std::string & sourceAddress )
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.
hostThe host or address configured with the endpoint.
portThe port number.
sourceAddressThe source IP address.

Member Function Documentation

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

Member Data Documentation

◆ host

::std::string Ice::IPEndpointInfo::host

The host or address configured with the endpoint.

◆ port

int Ice::IPEndpointInfo::port

The port number.

◆ sourceAddress

::std::string Ice::IPEndpointInfo::sourceAddress

The source IP address.


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