NCBI C++ ToolKit
Public Member Functions | Private Attributes | List of all members
CRemoteAppResult Class Reference

Search Toolkit Book for CRemoteAppResult

Remote Application Result (both client side and application executor side) More...

#include <connect/services/remote_app.hpp>

+ Collaboration diagram for CRemoteAppResult:

Public Member Functions

 CRemoteAppResult (CNetCacheAPI::TInstance netcache_api, size_t max_inline_size=kMaxBlobInlineSize)
 
 ~CRemoteAppResult ()
 
CNcbiOstreamGetStdOutForWrite ()
 Get a stream to put remote application's stdout to. More...
 
CNcbiIstreamGetStdOut ()
 Get a remote application stdout. More...
 
CNcbiOstreamGetStdErrForWrite ()
 
CNcbiIstreamGetStdErr ()
 Get a remote application stderr. More...
 
void SetRetCode (int ret_code)
 
int GetRetCode () const
 
void Serialize (CNcbiOstream &os)
 
void Receive (CNcbiIstream &is)
 Deserialize a request from a given stream. More...
 
void Reset ()
 
void SetStdOutErrFileNames (const string &stdout_fname, const string &stderr_fname, EStdOutErrStorageType type)
 
const stringGetStdOutFileName () const
 
const stringGetStdErrFileName () const
 
EStdOutErrStorageType GetStdOutErrStorageType () const
 
const stringGetOutBlobIdOrData () const
 
const stringGetErrBlobIdOrData () const
 
void SetMaxInlineSize (size_t max_inline_size)
 

Private Attributes

CNetCacheAPI m_NetCacheAPI
 
int m_RetCode
 
CBlobStreamHelper m_StdOut
 
string m_OutBlobIdOrData
 
size_t m_OutBlobSize
 
string m_StdOutFileName
 
CBlobStreamHelper m_StdErr
 
string m_ErrBlobIdOrData
 
size_t m_ErrBlobSize
 
string m_StdErrFileName
 
EStdOutErrStorageType m_StorageType
 
size_t m_MaxInlineSize
 

Detailed Description

Remote Application Result (both client side and application executor side)

It is used by a grid worker node to send results of a finished remote application to the client.

It is also used by the client application to get the job results and should be used in conjunction with CGridJobStatus

Definition at line 208 of file remote_app.hpp.

Constructor & Destructor Documentation

◆ CRemoteAppResult()

CRemoteAppResult::CRemoteAppResult ( CNetCacheAPI::TInstance  netcache_api,
size_t  max_inline_size = kMaxBlobInlineSize 
)
inline

Definition at line 211 of file remote_app.hpp.

◆ ~CRemoteAppResult()

CRemoteAppResult::~CRemoteAppResult ( )

Definition at line 340 of file remote_app.cpp.

References NCBI_CATCH_ALL_X, and Reset().

Member Function Documentation

◆ GetErrBlobIdOrData()

const string& CRemoteAppResult::GetErrBlobIdOrData ( ) const
inline

Definition at line 270 of file remote_app.hpp.

References m_ErrBlobIdOrData.

◆ GetOutBlobIdOrData()

const string& CRemoteAppResult::GetOutBlobIdOrData ( ) const
inline

Definition at line 269 of file remote_app.hpp.

References m_OutBlobIdOrData.

◆ GetRetCode()

int CRemoteAppResult::GetRetCode ( ) const
inline

Definition at line 249 of file remote_app.hpp.

References m_RetCode.

Referenced by Serialize().

◆ GetStdErr()

CNcbiIstream& CRemoteAppResult::GetStdErr ( )
inline

Get a remote application stderr.

Definition at line 243 of file remote_app.hpp.

References CBlobStreamHelper::GetIStream(), m_StdErr, m_StdErrFileName, and m_StorageType.

Referenced by CGridCommandLineInterfaceApp::DumpJobInputOutput().

◆ GetStdErrFileName()

const string& CRemoteAppResult::GetStdErrFileName ( ) const
inline

Definition at line 266 of file remote_app.hpp.

References m_StdErrFileName.

◆ GetStdErrForWrite()

CNcbiOstream& CRemoteAppResult::GetStdErrForWrite ( )
inline

◆ GetStdOut()

CNcbiIstream& CRemoteAppResult::GetStdOut ( )
inline

Get a remote application stdout.

Definition at line 232 of file remote_app.hpp.

References CBlobStreamHelper::GetIStream(), m_StdOut, m_StdOutFileName, and m_StorageType.

Referenced by CGridCommandLineInterfaceApp::DumpJobInputOutput().

◆ GetStdOutErrStorageType()

EStdOutErrStorageType CRemoteAppResult::GetStdOutErrStorageType ( ) const
inline

Definition at line 267 of file remote_app.hpp.

References m_StorageType.

◆ GetStdOutFileName()

const string& CRemoteAppResult::GetStdOutFileName ( ) const
inline

Definition at line 265 of file remote_app.hpp.

References m_StdOutFileName.

◆ GetStdOutForWrite()

CNcbiOstream& CRemoteAppResult::GetStdOutForWrite ( )
inline

Get a stream to put remote application's stdout to.

Definition at line 226 of file remote_app.hpp.

References CBlobStreamHelper::GetOStream(), m_MaxInlineSize, m_StdOut, m_StdOutFileName, and m_StorageType.

◆ Receive()

void CRemoteAppResult::Receive ( CNcbiIstream is)

Deserialize a request from a given stream.

Definition at line 355 of file remote_app.cpp.

References m_ErrBlobIdOrData, m_OutBlobIdOrData, ReadStrWithLen(), Reset(), and SetRetCode().

Referenced by CGridCommandLineInterfaceApp::DumpJobInputOutput().

◆ Reset()

void CRemoteAppResult::Reset ( void  )

◆ Serialize()

void CRemoteAppResult::Serialize ( CNcbiOstream os)

◆ SetMaxInlineSize()

void CRemoteAppResult::SetMaxInlineSize ( size_t  max_inline_size)
inline

Definition at line 272 of file remote_app.hpp.

References m_MaxInlineSize.

◆ SetRetCode()

void CRemoteAppResult::SetRetCode ( int  ret_code)
inline

Definition at line 248 of file remote_app.hpp.

References m_RetCode.

Referenced by Receive().

◆ SetStdOutErrFileNames()

void CRemoteAppResult::SetStdOutErrFileNames ( const string stdout_fname,
const string stderr_fname,
EStdOutErrStorageType  type 
)
inline

Definition at line 257 of file remote_app.hpp.

References m_StdErrFileName, m_StdOutFileName, m_StorageType, and type.

Member Data Documentation

◆ m_ErrBlobIdOrData

string CRemoteAppResult::m_ErrBlobIdOrData
private

Definition at line 285 of file remote_app.hpp.

Referenced by GetErrBlobIdOrData(), Receive(), Reset(), and Serialize().

◆ m_ErrBlobSize

size_t CRemoteAppResult::m_ErrBlobSize
private

Definition at line 286 of file remote_app.hpp.

Referenced by Reset().

◆ m_MaxInlineSize

size_t CRemoteAppResult::m_MaxInlineSize
private

Definition at line 289 of file remote_app.hpp.

Referenced by GetStdErrForWrite(), GetStdOutForWrite(), and SetMaxInlineSize().

◆ m_NetCacheAPI

CNetCacheAPI CRemoteAppResult::m_NetCacheAPI
private

Definition at line 276 of file remote_app.hpp.

◆ m_OutBlobIdOrData

string CRemoteAppResult::m_OutBlobIdOrData
private

Definition at line 280 of file remote_app.hpp.

Referenced by GetOutBlobIdOrData(), Receive(), Reset(), and Serialize().

◆ m_OutBlobSize

size_t CRemoteAppResult::m_OutBlobSize
private

Definition at line 281 of file remote_app.hpp.

Referenced by Reset().

◆ m_RetCode

int CRemoteAppResult::m_RetCode
private

Definition at line 277 of file remote_app.hpp.

Referenced by GetRetCode(), Reset(), and SetRetCode().

◆ m_StdErr

CBlobStreamHelper CRemoteAppResult::m_StdErr
private

Definition at line 284 of file remote_app.hpp.

Referenced by GetStdErr(), GetStdErrForWrite(), Reset(), and Serialize().

◆ m_StdErrFileName

string CRemoteAppResult::m_StdErrFileName
private

◆ m_StdOut

CBlobStreamHelper CRemoteAppResult::m_StdOut
private

Definition at line 279 of file remote_app.hpp.

Referenced by GetStdOut(), GetStdOutForWrite(), Reset(), and Serialize().

◆ m_StdOutFileName

string CRemoteAppResult::m_StdOutFileName
private

◆ m_StorageType

EStdOutErrStorageType CRemoteAppResult::m_StorageType
private

The documentation for this class was generated from the following files:
Modified on Mon May 20 05:05:03 2024 by modify_doxy.py rev. 669887