Faspstream Manager C/C++ API
3.6.1
A C and C++ language interface to basic streaming over the fasp protocol
|
#include <FaspInputStreamFromFile.h>
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.
FASPSTREAM_CPP_API FaspInputStreamFromFile::FaspInputStreamFromFile | ( | ) |
FASPSTREAM_CPP_API FaspInputStreamFromFile::~FaspInputStreamFromFile | ( | ) |
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 | ( | ) |