Base class providing access to the endpoint details. More...
defined in <Ice/Endpoint.ice>
local class EndpointInfo { ... }
Inheritance diagram for Ice::EndpointInfo:
Collaboration diagram for Ice::EndpointInfo:
Operations | |
| bool | datagram () |
| Returns true if this endpoint is a datagram endpoint. More... | |
| bool | secure () |
| Returns true if this endpoint is a secure endpoint. More... | |
| short | type () |
| Returns the type of the endpoint. More... | |
Data Members | |
| 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... | |
| 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.
Operation Documentation
◆ datagram()
["cpp:const","cpp:noexcept","swift:noexcept"]
| bool datagram | ( | ) |
Returns true if this endpoint is a datagram endpoint.
- Returns
- True for a datagram endpoint.
◆ secure()
["cpp:const","cpp:noexcept","swift:noexcept"]
| bool secure | ( | ) |
Returns true if this endpoint is a secure endpoint.
- Returns
- True for a secure endpoint.
◆ type()
["cpp:const","cpp:noexcept","swift:noexcept"]
| short type | ( | ) |
Returns the type of the endpoint.
- Returns
- The endpoint type.
Data Member Documentation
◆ compress
| bool compress |
Specifies whether or not compression should be used if available when using this endpoint.
◆ timeout
| int timeout |
The timeout for the endpoint in milliseconds.
0 means non-blocking, -1 means no timeout.
◆ underlying
| 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:
- Ice/Endpoint.ice
