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

Provides access to a WebSocket endpoint information. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::WSEndpointInfo:
Collaboration diagram for Ice::WSEndpointInfo:

Public Member Functions

WSEndpointInfooperator= (const WSEndpointInfo &)=default
WSEndpointInfooperator= (WSEndpointInfo &&)=default
 WSEndpointInfo ()=default
 WSEndpointInfo (const ::std::shared_ptr<::Ice::EndpointInfo > &underlying, int timeout, bool compress, const ::std::string &resource)
 One-shot constructor to initialize all data members.
 WSEndpointInfo (const WSEndpointInfo &)=default
 WSEndpointInfo (WSEndpointInfo &&)=default
virtual ~WSEndpointInfo ()
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 resource
 The URI configured with the endpoint.
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 a WebSocket endpoint information.

Constructor & Destructor Documentation

◆ ~WSEndpointInfo()

virtual Ice::WSEndpointInfo::~WSEndpointInfo ( )
virtual

◆ WSEndpointInfo() [1/4]

Ice::WSEndpointInfo::WSEndpointInfo ( )
default

◆ WSEndpointInfo() [2/4]

Ice::WSEndpointInfo::WSEndpointInfo ( const WSEndpointInfo & )
default

◆ WSEndpointInfo() [3/4]

Ice::WSEndpointInfo::WSEndpointInfo ( WSEndpointInfo && )
default

◆ WSEndpointInfo() [4/4]

Ice::WSEndpointInfo::WSEndpointInfo ( const ::std::shared_ptr<::Ice::EndpointInfo > & underlying,
int timeout,
bool compress,
const ::std::string & resource )
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.
resourceThe URI configured with the endpoint.

Member Function Documentation

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

Member Data Documentation

◆ resource

::std::string Ice::WSEndpointInfo::resource

The URI configured with the endpoint.


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