TunnelStreamRequest encapsulates tunnel stream request parameters.
More...
TunnelStreamRequest contains options used for creation of a tunnel stream.
ClassOfService cos;
.recvWindowSize( 1200 )
.sendWindowSize( 1200 ) )
tsr.classOfService( cos )
.name( "TUNNEL_STREAM" )
.serviceId( 1 )
.responseTimeout( 45 );
static const refinitiv::ema::access::UInt8 MMT_SYSTEM
- See also
- ClassOfService, OmmConsumer
Definition at line 586 of file TunnelStreamRequest.h.
◆ TunnelStreamRequest() [1/2]
refinitiv::ema::access::TunnelStreamRequest::TunnelStreamRequest |
( |
| ) |
|
◆ TunnelStreamRequest() [2/2]
refinitiv::ema::access::TunnelStreamRequest::TunnelStreamRequest |
( |
const TunnelStreamRequest & |
other | ) |
|
Copy constructor
- Parameters
-
◆ ~TunnelStreamRequest()
virtual refinitiv::ema::access::TunnelStreamRequest::~TunnelStreamRequest |
( |
| ) |
|
|
virtual |
◆ classOfService()
Specifies the ClassOfService.
- Parameters
-
- Returns
- reference to this object
◆ clear()
Clears object by setting defaults
- Returns
- reference to this object
◆ domainType()
Specifies DomainType.
- Parameters
-
[in] | domainType | specifies RDM Message Model Type |
- Returns
- reference to this object
- Exceptions
-
◆ getClassOfService()
const ClassOfService& refinitiv::ema::access::TunnelStreamRequest::getClassOfService |
( |
| ) |
const |
◆ getDomainType()
UInt16 refinitiv::ema::access::TunnelStreamRequest::getDomainType |
( |
| ) |
const |
Returns DomainType.
- Returns
- domain type
◆ getGuaranteedOutputBuffers()
UInt32 refinitiv::ema::access::TunnelStreamRequest::getGuaranteedOutputBuffers |
( |
| ) |
const |
Returns number of GuaranteedOutputBuffers.
- Returns
- number of guaranteed output buffers
◆ getLoginReqMsg()
const ReqMsg& refinitiv::ema::access::TunnelStreamRequest::getLoginReqMsg |
( |
| ) |
const |
Returns Login request message
- Returns
- login request message
- Exceptions
-
◆ getName()
const EmaString& refinitiv::ema::access::TunnelStreamRequest::getName |
( |
| ) |
const |
Returns tunnel stream name.
- Returns
- tunnel stream name
- Exceptions
-
◆ getResponseTimeOut()
UInt32 refinitiv::ema::access::TunnelStreamRequest::getResponseTimeOut |
( |
| ) |
const |
Returns ResponseTimeOut.
- Returns
- response timeOut
◆ getServiceId()
UInt32 refinitiv::ema::access::TunnelStreamRequest::getServiceId |
( |
| ) |
const |
Returns ServiceId.
- Returns
- service id
- Exceptions
-
◆ getServiceName()
const EmaString& refinitiv::ema::access::TunnelStreamRequest::getServiceName |
( |
| ) |
const |
Returns ServiceNme.
- Returns
- service name
- Exceptions
-
◆ guaranteedOutputBuffers()
Specifies the number of guaranteed output buffers available for the tunnel stream.
- Parameters
-
[in] | value | specifies number of output buffers |
- Returns
- reference to this object
◆ hasLoginReqMsg()
bool refinitiv::ema::access::TunnelStreamRequest::hasLoginReqMsg |
( |
| ) |
const |
Indicates presence of login request message.
- Returns
- true if login request message is set
◆ hasName()
bool refinitiv::ema::access::TunnelStreamRequest::hasName |
( |
| ) |
const |
Indicates presence of name
- Returns
- true if service name is set
◆ hasServiceId()
bool refinitiv::ema::access::TunnelStreamRequest::hasServiceId |
( |
| ) |
const |
Indicates presence of service id
- Returns
- true if service id is set
◆ hasServiceName()
bool refinitiv::ema::access::TunnelStreamRequest::hasServiceName |
( |
| ) |
const |
Indicates presence of service name
- Returns
- true if service name is set
◆ loginReqMsg()
Specifies login request message to be used if authentication type is set to CosAuthentication::OmmLoginEnum.
- Parameters
-
[in] | loginReq | specifies the OMM login request message |
- Returns
- reference to this object
◆ name()
Specifies the tunnel stream name, which is provided to the remote application.
- Parameters
-
[in] | name | specifies tunnel stream name |
- Returns
- reference to this object
◆ operator=()
Assignment operator
- Parameters
-
- Returns
- reference to this object
◆ responseTimeout()
Sets the duration to wait for a provider to respond to a tunnel stream open request.
- Parameters
-
[in] | timeOut | specifies time to wait for the response to the open request (in seconds) |
- Returns
- reference to this object
◆ serviceId()
Specifies ServiceId.
- Parameters
-
[in] | serviceId | specifies service id |
- Returns
- reference to this object
- Exceptions
-
◆ serviceName()
Specifies ServiceName.
- Parameters
-
[in] | serviceName | specifies service name |
- Returns
- reference to this object
- Exceptions
-