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

Provides access to an UDP endpoint information. More...

#include <Ice/Ice.h>

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

Public Member Functions

UDPEndpointInfooperator= (const UDPEndpointInfo &)=default
 
UDPEndpointInfooperator= (UDPEndpointInfo &&)=default
 
 UDPEndpointInfo ()=default
 
 UDPEndpointInfo (const ::std::shared_ptr<::Ice::EndpointInfo > &underlying, int timeout, bool compress, const ::std::string &host, int port, const ::std::string &sourceAddress, const ::std::string &mcastInterface, int mcastTtl)
 One-shot constructor to initialize all data members. More...
 
 UDPEndpointInfo (const UDPEndpointInfo &)=default
 
 UDPEndpointInfo (UDPEndpointInfo &&)=default
 
virtual ~UDPEndpointInfo ()
 
- Public Member Functions inherited from Ice::IPEndpointInfo
 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. More...
 
 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. 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

::std::string mcastInterface
 The multicast interface. More...
 
int mcastTtl
 The multicast time-to-live (or hops). More...
 
- Public Attributes inherited from Ice::IPEndpointInfo
::std::string host
 The host or address configured with the endpoint. More...
 
int port
 The port number. More...
 
::std::string sourceAddress
 The source IP address. 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 an UDP endpoint information.

See also
Endpoint

Constructor & Destructor Documentation

◆ ~UDPEndpointInfo()

virtual Ice::UDPEndpointInfo::~UDPEndpointInfo ( )
virtual

◆ UDPEndpointInfo() [1/4]

Ice::UDPEndpointInfo::UDPEndpointInfo ( )
default

◆ UDPEndpointInfo() [2/4]

Ice::UDPEndpointInfo::UDPEndpointInfo ( const UDPEndpointInfo )
default

◆ UDPEndpointInfo() [3/4]

Ice::UDPEndpointInfo::UDPEndpointInfo ( UDPEndpointInfo &&  )
default

◆ UDPEndpointInfo() [4/4]

Ice::UDPEndpointInfo::UDPEndpointInfo ( const ::std::shared_ptr<::Ice::EndpointInfo > &  underlying,
int  timeout,
bool  compress,
const ::std::string &  host,
int  port,
const ::std::string &  sourceAddress,
const ::std::string &  mcastInterface,
int  mcastTtl 
)
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.
mcastInterfaceThe multicast interface.
mcastTtlThe multicast time-to-live (or hops).

Member Function Documentation

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

Member Data Documentation

◆ mcastInterface

::std::string Ice::UDPEndpointInfo::mcastInterface

The multicast interface.

◆ mcastTtl

int Ice::UDPEndpointInfo::mcastTtl

The multicast time-to-live (or hops).


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