RStudio Launcher Plugin SDK  1.1.3
A software development kit for creating plugins that work the the RStudio Launcher.
Public Member Functions | List of all members
rstudio::launcher_plugins::api::StreamSequenceId Class Referencefinal

An identifier for a MultiStreamResponse. More...

#include <ResponseTypes.hpp>

Public Member Functions

 StreamSequenceId (uint64_t in_requestId, uint64_t in_sequenceId)
 Constructor. More...
 
 StreamSequenceId (const StreamSequenceId &in_other)
 Copy constructor. More...
 
 StreamSequenceId (StreamSequenceId &&in_other) noexcept
 Move constructor. More...
 
 ~StreamSequenceId ()=default
 Destructor.
 
StreamSequenceIdoperator= (const StreamSequenceId &in_other)
 Assignment operator. More...
 
StreamSequenceIdoperator= (StreamSequenceId &&in_other) noexcept
 Move operator. More...
 
json::Object toJson () const
 Converts this StreamSequenceId to a JSON Object. More...
 

Detailed Description

An identifier for a MultiStreamResponse.

Constructor & Destructor Documentation

◆ StreamSequenceId() [1/3]

rstudio::launcher_plugins::api::StreamSequenceId::StreamSequenceId ( uint64_t  in_requestId,
uint64_t  in_sequenceId 
)

Constructor.

Parameters
in_requestIdThe ID of the request for which this response will be streamed.
in_sequenceIdThe ID of this response in the sequence of streamed responses for the specified request.

◆ StreamSequenceId() [2/3]

rstudio::launcher_plugins::api::StreamSequenceId::StreamSequenceId ( const StreamSequenceId in_other)

Copy constructor.

Parameters
in_otherThe StreamSequenceId to be copied into this.

◆ StreamSequenceId() [3/3]

rstudio::launcher_plugins::api::StreamSequenceId::StreamSequenceId ( StreamSequenceId &&  in_other)
noexcept

Move constructor.

Parameters
in_otherThe StreamSequenceId to be moved into this.

Member Function Documentation

◆ operator=() [1/2]

StreamSequenceId& rstudio::launcher_plugins::api::StreamSequenceId::operator= ( const StreamSequenceId in_other)

Assignment operator.

Parameters
in_otherThe StreamSequenceId to be copied into this.
Returns
A reference to this StreamSequenceId.

◆ operator=() [2/2]

StreamSequenceId& rstudio::launcher_plugins::api::StreamSequenceId::operator= ( StreamSequenceId &&  in_other)
noexcept

Move operator.

Parameters
in_otherThe StreamSequenceId to be moved into this.
Returns
A reference to this StreamSequenceId.

◆ toJson()

json::Object rstudio::launcher_plugins::api::StreamSequenceId::toJson ( ) const

Converts this StreamSequenceId to a JSON Object.

Returns
The JSON object which represents this StreamSequenceId.

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