Faspstream Manager C/C++ API  3.6.1
A C and C++ language interface to basic streaming over the fasp protocol
FaspInputStreamFromFile Class Reference

#include <FaspInputStreamFromFile.h>

Public Member Functions

std::vector< std::string > getCommandline () const
 
FASPSTREAM_CPP_API FaspInputStreamFromFile ()
 
FASPSTREAM_CPP_API ~FaspInputStreamFromFile ()
 
FASPSTREAM_CPP_API void setAscpPath (const std::string &ascpPath)
 
FASPSTREAM_CPP_API std::string getAscpPath () const
 
FASPSTREAM_CPP_API void setSshKeyFilePath (const std::string &sshKeyFilePath)
 
FASPSTREAM_CPP_API std::string getSshKeyFilePath () const
 
FASPSTREAM_CPP_API void setSourceFilePath (const std::string &sourceFilePath)
 
FASPSTREAM_CPP_API std::string getSourceFilePath () const
 
FASPSTREAM_CPP_API void setUsername (const std::string &username)
 
FASPSTREAM_CPP_API std::string getUsername () const
 
FASPSTREAM_CPP_API void setPassword (const std::string &password)
 
FASPSTREAM_CPP_API std::string getPassword () const
 
FASPSTREAM_CPP_API void setHostname (const std::string &hostname)
 
FASPSTREAM_CPP_API std::string getHostname () const
 
FASPSTREAM_CPP_API void setDatagramSize (const long datagramSize)
 
FASPSTREAM_CPP_API long getDatagramSize () const
 
FASPSTREAM_CPP_API void setChunkSize (const long chunkSize)
 
FASPSTREAM_CPP_API long getChunkSize () const
 
FASPSTREAM_CPP_API void setTargetRate (const long minRate)
 
FASPSTREAM_CPP_API long getTargetRate () const
 
FASPSTREAM_CPP_API void setMinRate (const long minRate)
 
FASPSTREAM_CPP_API long getMinRate () const
 
FASPSTREAM_CPP_API void setPolicy (FASPSTREAM_POLICY_TYPE ascpPath)
 
FASPSTREAM_CPP_API FASPSTREAM_POLICY_TYPE getPolicy () const
 
FASPSTREAM_CPP_API bool startReceiver ()
 
FASPSTREAM_CPP_API int getTcpPort () const
 
FASPSTREAM_CPP_API void setTcpPort (int udpPort)
 
FASPSTREAM_CPP_API int getUdpPort () const
 
FASPSTREAM_CPP_API void setUdpPort (int udpPort)
 
FASPSTREAM_CPP_API int getMaxMemory () const
 
FASPSTREAM_CPP_API void setMaxMemory (int maxMem)
 
FASPSTREAM_CPP_API std::string getLogDirectory () const
 
FASPSTREAM_CPP_API int read (char *buffer, int offset, int length)
 
FASPSTREAM_CPP_API std::string close ()
 
FASPSTREAM_CPP_API void forceClose ()
 
FASPSTREAM_CPP_API bool eof ()
 
FASPSTREAM_CPP_API void setLicense (std::string commandToExecute)
 
FASPSTREAM_CPP_API std::string getLicense () const
 

Detailed Description

Use the FaspInputStreamFromFile class to receive file data streamed from a file located on an Aspera server. Note this class does not inherit from any of the C++ std::ios stream classes, and requires the user to implement a read() loop to receive the data.

Constructor & Destructor Documentation

FASPSTREAM_CPP_API FaspInputStreamFromFile::FaspInputStreamFromFile ( )
FASPSTREAM_CPP_API FaspInputStreamFromFile::~FaspInputStreamFromFile ( )

Member Function Documentation

FASPSTREAM_CPP_API std::string FaspInputStreamFromFile::close ( )
FASPSTREAM_CPP_API bool FaspInputStreamFromFile::eof ( )
FASPSTREAM_CPP_API void FaspInputStreamFromFile::forceClose ( )
FASPSTREAM_CPP_API std::string FaspInputStreamFromFile::getAscpPath ( ) const
FASPSTREAM_CPP_API long FaspInputStreamFromFile::getChunkSize ( ) const
std::vector<std::string> FaspInputStreamFromFile::getCommandline ( ) const

This method can be used to generate the command line arguments with which the faspstream child process will be invoked, it can be useful for debugging purposes but is not normally necessary.

FASPSTREAM_CPP_API long FaspInputStreamFromFile::getDatagramSize ( ) const
FASPSTREAM_CPP_API std::string FaspInputStreamFromFile::getHostname ( ) const
FASPSTREAM_CPP_API std::string FaspInputStreamFromFile::getLicense ( ) const
FASPSTREAM_CPP_API std::string FaspInputStreamFromFile::getLogDirectory ( ) const
FASPSTREAM_CPP_API int FaspInputStreamFromFile::getMaxMemory ( ) const
FASPSTREAM_CPP_API long FaspInputStreamFromFile::getMinRate ( ) const
FASPSTREAM_CPP_API std::string FaspInputStreamFromFile::getPassword ( ) const
FASPSTREAM_CPP_API FASPSTREAM_POLICY_TYPE FaspInputStreamFromFile::getPolicy ( ) const
FASPSTREAM_CPP_API std::string FaspInputStreamFromFile::getSourceFilePath ( ) const
FASPSTREAM_CPP_API std::string FaspInputStreamFromFile::getSshKeyFilePath ( ) const
FASPSTREAM_CPP_API long FaspInputStreamFromFile::getTargetRate ( ) const
FASPSTREAM_CPP_API int FaspInputStreamFromFile::getTcpPort ( ) const
FASPSTREAM_CPP_API int FaspInputStreamFromFile::getUdpPort ( ) const
FASPSTREAM_CPP_API std::string FaspInputStreamFromFile::getUsername ( ) const
FASPSTREAM_CPP_API int FaspInputStreamFromFile::read ( char *  buffer,
int  offset,
int  length 
)
FASPSTREAM_CPP_API void FaspInputStreamFromFile::setAscpPath ( const std::string &  ascpPath)
FASPSTREAM_CPP_API void FaspInputStreamFromFile::setChunkSize ( const long  chunkSize)
FASPSTREAM_CPP_API void FaspInputStreamFromFile::setDatagramSize ( const long  datagramSize)
FASPSTREAM_CPP_API void FaspInputStreamFromFile::setHostname ( const std::string &  hostname)
FASPSTREAM_CPP_API void FaspInputStreamFromFile::setLicense ( std::string  commandToExecute)
FASPSTREAM_CPP_API void FaspInputStreamFromFile::setMaxMemory ( int  maxMem)
FASPSTREAM_CPP_API void FaspInputStreamFromFile::setMinRate ( const long  minRate)
FASPSTREAM_CPP_API void FaspInputStreamFromFile::setPassword ( const std::string &  password)
FASPSTREAM_CPP_API void FaspInputStreamFromFile::setPolicy ( FASPSTREAM_POLICY_TYPE  ascpPath)
FASPSTREAM_CPP_API void FaspInputStreamFromFile::setSourceFilePath ( const std::string &  sourceFilePath)
FASPSTREAM_CPP_API void FaspInputStreamFromFile::setSshKeyFilePath ( const std::string &  sshKeyFilePath)
FASPSTREAM_CPP_API void FaspInputStreamFromFile::setTargetRate ( const long  minRate)
FASPSTREAM_CPP_API void FaspInputStreamFromFile::setTcpPort ( int  udpPort)
FASPSTREAM_CPP_API void FaspInputStreamFromFile::setUdpPort ( int  udpPort)
FASPSTREAM_CPP_API void FaspInputStreamFromFile::setUsername ( const std::string &  username)
FASPSTREAM_CPP_API bool FaspInputStreamFromFile::startReceiver ( )

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