Qorus Integration Engine®  4.0.3_git
OMQ::FsRemote Class Reference

A high level API for a remote system.fs service. More...

Public Member Methods

 constructor (string remote, *hash opts)
 constructor taking a string giving the name of the remote connection for the remote server More...
 
 constructor (QorusSystemRestHelper remote, *hash opts)
 constructor taking an OMQ::QorusSystemRestHelper object for the remote connection More...
 
OMQ::StreamConfig config ()
 returns the configuration object
 
 disconnect ()
 Disconnects the connection.
 

Detailed Description

A high level API for a remote system.fs service.

FsRemote provides a high level API for the system.fs service in remote Qorus instances. Use it for single filesystem operations.

Warning
Use OMQ::FsRemoteSend and OMQ::AbstractFsRemoteReceive for sending and retrieving large files. These classes are optimized for high volume data. Any use of e.g. FsRemote::write_file() will store all data in the memory and the data will be transferred in a single call.

FsRemote API calls

This class does not have any of its own methods; all method calls are redirected to the system.fs service transparently.

Example of usage
QorusClient::init2();
FsRemote fs("msepl-it");
list ls = fs.ls("/tmp"); # list files in /tmp directory
printf("%N\n", ls);

Member Function Documentation

◆ constructor() [1/2]

OMQ::FsRemote::constructor ( string  remote,
*hash  opts 
)

constructor taking a string giving the name of the remote connection for the remote server

Parameters
remotea string giving the name of the remote connection for the remote server
optsoptional Streaming API Constructor Options as follows:
  • "timeout": an HTTP socket timeout value in milliseconds; used locally and in the remote for socket I/O and queue operations; default value: 5m
  • "loglevel": a default log level option for logging; see Log Levels for valid value
  • "no_remote_timeout": if True the "timeout" option will not be sent to the remote
Note
the explicit or default timeout value here overrides any socket I/O timeout set for the remote connection object

◆ constructor() [2/2]

OMQ::FsRemote::constructor ( QorusSystemRestHelper  remote,
*hash  opts 
)

constructor taking an OMQ::QorusSystemRestHelper object for the remote connection

Parameters
remotean OMQ::QorusSystemRestHelper object
optsoptional Streaming API Constructor Options as follows:
  • "timeout": an HTTP socket timeout value in milliseconds; used locally and in the remote for socket I/O and queue operations; default value: 5m
  • "loglevel": a default log level option for logging; see Log Levels for valid value
  • "no_remote_timeout": if True the "timeout" option will not be sent to the remote
Note
the explicit or default timeout value here overrides any socket I/O timeout set for the remote connection object

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