API Documentation

FileTransferExtMessage

FileTransferExtMessage::FileTransferExtMessage ( )

A default constructor.

FileTransferExtMessage::FileTransferExtMessage ( … )

A copy constructor.

Parameters
in/out type description
in const FileTransferExtMessage & Instance being copied.

FileTransferExtMessage::FileTransferExtMessage ( … )

This will pair with a node to construct and enable publishing.

Parameters
in/out type description
in Node & Reference to node.

FileTransferExtMessage::FileTransferExtMessage ( … )

This will pair with a node to construct and enable publishing and message copying.

Parameters
in/out type description
in Node & Reference to node.
in ps_msg_ref Message to copy.

FileTransferExtMessage::FileTransferExtMessage ( … )

A convenience constructor from a related type.

Parameters
in/out type description
in const ps_file_transfer_ext_msg & Instance of related type.

FileTransferExtMessage::~FileTransferExtMessage ( )

A default destructor.

FileTransferExtMessage::print ( … )

This will print internal values.

Parameters
in/out type description
in std::ostream & Output stream that defaults to std::cout.
Returns
  • void

FileTransferExtMessage::get_ps_file_transfer_ext_msg ( ) const

This will provide convenient access to a related type.

Returns

FileTransferExtMessage::operator= ( … )

An assignment operator.

Parameters
in/out type description
in const FileTransferExtMessage & Instance to copy.
Returns

static FileTransferExtMessage::getName ( )

This will get a message name. It is useful in functions requiring message names, such as getMessageTypeByName.

Returns
  • std::string

FileTransferExtMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

FileTransferExtMessage::setHeader ( … )

Parameters
in/out type description
in MsgHeader & Message header.
Returns
  • void

FileTransferExtMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

FileTransferExtMessage::setHeaderType ( … )

This will set a message type identifier.

Parameters
in/out type description
in ps_msg_type Message type identifier.
Returns
  • void

FileTransferExtMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

FileTransferExtMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

Parameters
in/out type description
in ps_timestamp In microseconds.
Returns
  • void

FileTransferExtMessage::getHeaderSrcGuid ( ) const

This will get a message producer’s GUID.

Returns

FileTransferExtMessage::setHeaderSrcGuid ( … )

This will set a message producer’s GUID.

Parameters
in/out type description
in ps_guid Message producer’s GUID.
Returns
  • void

FileTransferExtMessage::getHostAddress ( ) const

This will get the host address.

Returns

FileTransferExtMessage::setHostAddress ( … )

This will set the host address.

Parameters
in/out type description
in ps_interface_address The new host address value.
Returns
  • void

FileTransferExtMessage::getDestinationGuid ( ) const

This will get the destination GUID.

Returns

FileTransferExtMessage::setDestinationGuid ( … )

This will set the destination GUID.

Parameters
in/out type description
in ps_guid The new destination GUID.
Returns
  • void

FileTransferExtMessage::getMode ( ) const

This will get the file transfer operation mode.

Returns

FileTransferExtMessage::setMode ( … )

This will set the file transfer operation mode.

Parameters
in/out type description
in ps_file_transfer_mode_kind The mode value.
Returns
  • void

FileTransferExtMessage::getSourcePath ( ) const

This will get the absolute source file path.

Returns

FileTransferExtMessage::setSourcePath ( … )

This will set the absolute source file path.

Parameters
in/out type description
in const std::array< char, PSYNC_FILE_TRANSFER_PATH_LENGTH > & The absolute file path.
Returns
  • void

FileTransferExtMessage::getDestinationPath ( ) const

This will get the absolute destination file path.

Returns

FileTransferExtMessage::setDestinationPath ( … )

This will set the absolute destination file path.

Parameters
in/out type description
in const std::array< char, PSYNC_FILE_TRANSFER_PATH_LENGTH > & The absolute file path.
Returns
  • void

FileTransferExtMessage::getChunkSize ( ) const

This will get the size of the transferred file chunks in bytes.

Returns
  • unsigned long

FileTransferExtMessage::setChunkSize ( … )

This will set the size of the transferred file chunks in bytes.

Parameters
in/out type description
in unsigned long The file chunk size in bytes.
Returns
  • void

FileTransferExtMessage::getInterChunkDelay ( ) const

This will get the delay time between each file chunk transfer.

Returns

FileTransferExtMessage::set ( … )

This will set the delay time between each file chunk transfer.

Parameters
in/out type description
in ps_timestamp The delay time.
Returns
  • void

FileTransferExtMessage::getRequireHash ( ) const

If the file transfer will use extra file hash for integrity checks, then this function will get them.

Returns
  • unsigned char

FileTransferExtMessage::setRequireHash ( … )

If the file transfer will use extra file hash for integrity checks, then this function will set them.

Parameters
in/out type description
in unsigned char Byte field flag if file hash will be used.
Returns
  • void