Aspera::FaspManager Namespace Reference

C++ Aspera Fasp Manager namespace. More...

Classes

class  CallbackFunctor
 
class  Environment
 This class contains configuration options for the fasp Manager. More...
 
class  Exception
 A class providing a base for FASP management related exception handling. More...
 
struct  FileStats
 A structure of FASP Job individual file level statistics. More...
 
class  Functor
 A class providing an abstract base for FASP functors. More...
 
class  InvalidOperationException
 A class to define an invalid API operation. More...
 
class  JobNotFoundException
 A class to define a FASP Manager job not found related execption. More...
 
struct  JobOrder
 A structure of the components that define a FASP Job transfer. More...
 
struct  JobStats
 A structure of FASP Job job level statistics. More...
 
class  Location
 A class representing a transfer end point. More...
 
class  Manager
 A class to manage FASP jobs. More...
 
class  SendException
 A class to define a FASP Manager send related exception. More...
 
class  SocketException
 A class to define a FASP Manager socket related execption. More...
 
class  StateException
 A class to define a FASP state related exception. More...
 
struct  UpdateParams
 A structure of update parameters. More...
 
class  ValidationException
 A class to define a FASP Manager validation exception. More...
 
class  XferException
 A class to define a FASP Manager transfer related execption. More...
 

Enumerations

enum  mgr_ctrl_t {
  CTRL_NONE = 0,
  CTRL_PAUSE = 0x01,
  CTRL_RESUME = 0x02,
  CTRL_CANCEL = 0x04,
  CTRL_UPDATE_RATE = 0x08,
  CTRL_UPDATE_MIN = 0x10,
  CTRL_UPDATE_POLICY = 0x20,
  CTRL_UPDATE = CTRL_UPDATE_RATE | CTRL_UPDATE_MIN | CTRL_UPDATE_POLICY
}
 An enumeration of FASP Manager control types.
 
enum  job_state_e {
  J_STATE_IDLE = 0x00,
  J_STATE_CONNECTING = 0x01,
  J_STATE_AUTHENTICATING = 0x02,
  J_STATE_STARTING = 0x03,
  J_STATE_TRANSFERRING = 0x04,
  J_STATE_FAILED = 0x05,
  J_STATE_FINISHED = 0x06,
  J_STATE_MAX
}
 An enumeration of FASP Job states.
 
enum  file_state_e {
  F_STATE_IDLE = 0x00,
  F_STATE_TRANSFERRING = 0x01,
  F_STATE_FAILED = 0x02,
  F_STATE_FINISHED = 0x03,
  F_STATE_SKIPPED = 0x04,
  F_STATE_MAX
}
 An enumeration of FASP Job file states.
 
enum  content_protect_e {
  CPROTECT_NONE = 0x00,
  CPROTECT_ENCRYPT = 0x01,
  CPROTECT_DECRYPT = 0x02
}
 
enum  encryption_type_e {
  ENCRYPT_NONE = 0x00,
  ENCRYPT_AES128 = 0x01
}
 An enumeration of encryption options.
 
enum  resume_type_e {
  RESUME_NONE = 0x00,
  RESUME_FILE_ATTRIB = 0x01,
  RESUME_SPARSE_CHKSUM = 0x02,
  RESUME_FULL_CHKSUM = 0x03
}
 An enumeration of modes of resuming a broken transfer. More...
 
enum  policy_e {
  POLICY_FIXED = 0x00,
  POLICY_HIGH = 0x01,
  POLICY_FAIR = 0x02,
  POLICY_LOW = 0x03
}
 
enum  fasp_version_e {
  VERSION_FASP1 = 0x01,
  VERSION_FASP2 = 0x02
}
 An enumeration of fasp version. More...
 
enum  xfer_direction_e {
  DIRECTION_SEND = 0x01,
  DIRECTION_RECEIVE = 0x02
}
 An enumeration of fasp version. More...
 
enum  symlink_policy_e {
  SYMLINK_P_FOLLOW = 1,
  SYMLINK_P_COPY = 2,
  SYMLINK_P_COPY_FORCE = 3,
  SYMLINK_P_SKIP = 4
}
 An enumeration for symlink policy. More...
 
enum  manifest_e {
  TEXT = 1,
  NONE = 2
}
 An enumeration for manifest. More...
 
enum  overwrite_e {
  NEVER = 1,
  ALWAYS = 2,
  DIFF = 3,
  OLDER = 4,
  DIFF_AND_OLDER = 5
}
 An enumeration for overwrite. More...
 
enum  callback_event_e {
  F_EVENT_BANDWIDTH_MEASUREMENT = 0x00,
  F_EVENT_CONNECTING = 0x01,
  F_EVENT_FILE_ERROR = 0x02,
  F_EVENT_FILE_START = 0x03,
  F_EVENT_FILE_STOP = 0x04,
  F_EVENT_PROGRESS = 0x05,
  F_EVENT_RATE_MODIFICATION = 0x06,
  F_EVENT_SESSION_ERROR = 0x07,
  F_EVENT_SESSION_START = 0x08,
  F_EVENT_SESSION_STOP = 0x09,
  F_EVENT_FILE_SKIP = 0x0a,
  FS_EVENT_MAX
}
 An enumeration of FASP Manager callback events.
 

Functions

mgr_ctrl_t operator| (mgr_ctrl_t a, mgr_ctrl_t b)
 
mgr_ctrl_toperator|= (mgr_ctrl_t &a, mgr_ctrl_t b)
 
mgr_ctrl_t operator& (mgr_ctrl_t a, mgr_ctrl_t b)
 

Detailed Description

C++ Aspera Fasp Manager namespace.

Enumeration Type Documentation

An enumeration of content protection modes Deprecated, no longer has any functionality

Enumerator
CPROTECT_NONE 

No protection.

CPROTECT_ENCRYPT 

Leave the content encrypted at the destination.

CPROTECT_DECRYPT 

Decrypt when transferring from an encrypted source.

An enumeration of fasp version.

Enumerator
VERSION_FASP1 

FASP Protocol Version 1.

VERSION_FASP2 

FASP Protocol Version 2.

enum manifest_e

An enumeration for manifest.

Enumerator
TEXT 

Generate Text.

NONE 

Generate Nonthing.

An enumeration for overwrite.

Enumerator
NEVER 

Never Overwrite.

ALWAYS 

Always Overwrite.

DIFF 

Overwrite when different.

OLDER 

Overwrite when older.

DIFF_AND_OLDER 

Overwrite when different and older.

enum policy_e

An enumeration of different transfer policies. Policy determines how FASP transfers treat other network traffic.

Enumerator
POLICY_FIXED 

Let the actual transfer rate match the target rate.

POLICY_HIGH 

Try to match the target rate, while being fair to other traffic. Yet take higher priority than other FASP transfer.

POLICY_FAIR 

Try to match the target rate, while being fair to other traffic.

POLICY_LOW 

Take lower priority than all other network traffic.

An enumeration of modes of resuming a broken transfer.

Enumerator
RESUME_NONE 

Do not resume.

RESUME_FILE_ATTRIB 

Resume if the file attributes match.

RESUME_SPARSE_CHKSUM 

Resume if sparse checksum matches.

RESUME_FULL_CHKSUM 

Resume only if the full checksum matches. (Could introduce delay with large files)

An enumeration for symlink policy.

Enumerator
SYMLINK_P_FOLLOW 

Follow symlinks.

SYMLINK_P_COPY 

Copy symlink.

SYMLINK_P_COPY_FORCE 

Force copy symlinks.

SYMLINK_P_SKIP 

Skip symlinks.

An enumeration of fasp version.

Enumerator
DIRECTION_SEND 

FASP Protocol Version 1.

DIRECTION_RECEIVE 

FASP Protocol Version 2.


Copyright © 2005 - 2016 Aspera, an IBM company. | asperasoft.com