Search Toolkit Book for CRemoteAppRequest

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

#include <connect/services/remote_app.hpp>

Inheritance diagram for CRemoteAppRequest:

Collaboration diagram for CRemoteAppRequest:

Public Member Functions
	CRemoteAppRequest (CNetCacheAPI::TInstance storage, size_t max_inline_size=kMaxBlobInlineSize)

	~CRemoteAppRequest ()

void	SetCmdLine (const string &cmdline)
	Set the command line for the remote application. More...

const string &	GetCmdLine () const
	Get the command line of the remote application. More...

void	SetAppRunTimeout (unsigned int sec)

unsigned int	GetAppRunTimeout () const

void	AddFileForTransfer (const string &fname, EStdOutErrStorageType tt=eBlobStorage)
	Transfer a file to an application executor side. More...

const string &	GetWorkingDir () const

CNcbiOstream &	GetStdIn ()
	Get an output stream to write data to a remote application stdin. More...

CNcbiIstream &	GetStdInForRead ()
	Get the stdin stream of the remote application. More...

void	SetExclusiveMode (bool on_off)

bool	IsExclusiveMode () const

void	SetStdOutErrFileNames (const string &stdout_fname, const string &stderr_fname, EStdOutErrStorageType type)

const string &	GetStdOutFileName () const

const string &	GetStdErrFileName () const

EStdOutErrStorageType	GetStdOutErrStorageType () const

const string &	GetInBlobIdOrData () const

void	SetMaxInlineSize (size_t max_inline_size)

void	Send (CNcbiOstream &os)
	Serialize a request to a given stream. More...

void	Deserialize (CNcbiIstream &is)

void	Reset ()

Protected Types
typedef map< string, EStdOutErrStorageType >	TFiles

typedef map< string, string >	TStoredFiles

Protected Member Functions
CNetCacheAPI &	GetNetCacheAPI ()

const TFiles &	GetFileNames () const

void	x_CreateWDir ()

void	x_RemoveWDir ()

bool	x_Deserialize (CNcbiIstream &is, TStoredFiles *files=NULL)

Private Attributes
CNetCacheAPI	m_NetCacheAPI

string	m_CmdLine

unsigned int	m_AppRunTimeout

string	m_TmpDirPath

string	m_TmpDirName

TFiles	m_Files

CBlobStreamHelper	m_StdIn

size_t	m_StdInDataSize

string	m_InBlobIdOrData

string	m_StdErrFileName

string	m_StdOutFileName

EStdOutErrStorageType	m_StorageType

bool	m_ExlusiveMode

size_t	m_MaxInlineSize

Static Private Attributes
static CAtomicCounter	sm_DirCounter

Detailed Description

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

It is used by a client application which wants to run a remote application through NetSchedule infrastructure and should be used in conjunction with CGridJobSubmitter class

It is also used by a grid worker node to get parameters for the remote application.

Definition at line 95 of file remote_app.hpp.

Member Typedef Documentation

◆ TFiles

typedef map<string, EStdOutErrStorageType> CRemoteAppRequest::TFiles

protected

Definition at line 166 of file remote_app.hpp.

◆ TStoredFiles

typedef map<string, string> CRemoteAppRequest::TStoredFiles

protected

Definition at line 174 of file remote_app.hpp.

Constructor & Destructor Documentation

◆ CRemoteAppRequest()

CRemoteAppRequest::CRemoteAppRequest	(	CNetCacheAPI::TInstance	storage,
		size_t	max_inline_size = `kMaxBlobInlineSize`
	)

explicit

Definition at line 327 of file remote_app.cpp.

◆ ~CRemoteAppRequest()

CRemoteAppRequest::~CRemoteAppRequest ( )

Definition at line 157 of file remote_app.cpp.

References NCBI_CATCH_ALL_X, and Reset().

Member Function Documentation

◆ AddFileForTransfer()

void CRemoteAppRequest::AddFileForTransfer	(	const string &	fname,
		EStdOutErrStorageType	tt = `eBlobStorage`
	)

inline

Transfer a file to an application executor side.

It only makes sense to transfer a file if its name also mentioned in the command line for the remote application. When the file is transfered the the executor side it gets stored to a temporary directory and then its original name in the command line will be replaced with the new temporary name.

Definition at line 118 of file remote_app.hpp.

References m_Files.

Referenced by CRemoteAppClientSampleApp::Run().