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

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

#include <Ice/Ice.h>

Inheritance diagram for Ice::UDPEndpointInfo:
Collaboration diagram for Ice::UDPEndpointInfo:

Public Types

typedef UDPEndpointInfoPtr PointerType
Public Types inherited from Ice::IPEndpointInfo
typedef IPEndpointInfoPtr PointerType
Public Types inherited from Ice::EndpointInfo
typedef EndpointInfoPtr PointerType

Public Member Functions

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

::std::string mcastInterface
 The multicast interface.
::Ice::Int mcastTtl
 The multicast time-to-live (or hops).
Public Attributes inherited from Ice::IPEndpointInfo
::std::string host
 The host or address configured with the endpoint.
::Ice::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.
::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

Provides access to an UDP endpoint information.

See also
Endpoint

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~UDPEndpointInfo()

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

◆ UDPEndpointInfo() [1/2]

Ice::UDPEndpointInfo::UDPEndpointInfo ( )
inline

◆ UDPEndpointInfo() [2/2]

Ice::UDPEndpointInfo::UDPEndpointInfo ( const ::Ice::EndpointInfoPtr & underlying,
::Ice::Int timeout,
bool compress,
const ::std::string & host,
::Ice::Int port,
const ::std::string & sourceAddress,
const ::std::string & mcastInterface,
::Ice::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 Data Documentation

◆ mcastInterface

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

The multicast interface.

◆ mcastTtl

::Ice::Int Ice::UDPEndpointInfo::mcastTtl

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


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