ZDK
Public Member Functions | List of all members
ZDK::IFileTransfer Class Referenceabstract
Inheritance diagram for ZDK::IFileTransfer:
ZDK::IZHandle

Public Member Functions

virtual void SetStatusListener (ZDK::Shared::FileTransferEventsHandler value)=0
 Set file transfer status listener. More...
 
virtual ZDK::Shared::Result InitiateTransfer (ZDK::Shared::String peer, ZDK::Shared::String name, int size, const char *digest, ZDK::Shared::String mimeType, ZDK::Shared::String timeCreated, ZDK::Shared::String timeModified, unsigned long long rangeStartOffset, unsigned long long rangeStopOffset)=0
 Initiate file transfer. More...
 
virtual ZDK::Shared::Result RequestTrasnfer (ZDK::Shared::String peer, ZDK::Shared::String name, int size, const char *digest, ZDK::Shared::String mimeType, ZDK::Shared::String timeCreated, ZDK::Shared::String timeModified, unsigned long long rangeStartOffset, unsigned long long rangeStopOffset)=0
 Request file transfer. More...
 
virtual ZDK::Shared::Result SetSenderDataBuffer (unsigned char *data)=0
 Set the sender data buffer. More...
 
virtual ZDK::Shared::Result Accept ()=0
 Accept file transfer request. More...
 
virtual ZDK::Shared::Result Reject ()=0
 Reject file transfer request. More...
 
virtual ZDK::Shared::Result Pause ()=0
 Pauses file transfer. More...
 
virtual ZDK::Shared::Result Resume ()=0
 Resumes file transfer. More...
 
virtual ZDK::Shared::Result Cancel ()=0
 Resumes file transfer. More...
 
- Public Member Functions inherited from ZDK::IZHandle
virtual ZDK::ZDKHandle Handle () const =0
 
virtual operator ZDK::ZDKHandle () const =0
 
virtual void Initialize ()=0
 
virtual void ReleaseReference ()=0
 

Member Function Documentation

◆ Accept()

virtual ZDK::Shared::Result ZDK::IFileTransfer::Accept ( )
pure virtual

Accept file transfer request.

◆ Cancel()

virtual ZDK::Shared::Result ZDK::IFileTransfer::Cancel ( )
pure virtual

Resumes file transfer.

◆ InitiateTransfer()

virtual ZDK::Shared::Result ZDK::IFileTransfer::InitiateTransfer ( ZDK::Shared::String  peer,
ZDK::Shared::String  name,
int  size,
const char *  digest,
ZDK::Shared::String  mimeType,
ZDK::Shared::String  timeCreated,
ZDK::Shared::String  timeModified,
unsigned long long  rangeStartOffset,
unsigned long long  rangeStopOffset 
)
pure virtual

Initiate file transfer.

Parameters
[in]peerThe peer
[in]nameName to put in the request
[in]sizeFile size
[in]digestDigest octets in binary form. This parameter is ignored if the digestType is E_DIGEST_UNKNOWN
[in]mimeTypeMIME type of the file
[in]timeCreatedRFC 5322 date-time of file creation.
[in]timeModifiedThe RFC 5322 date-time of last file modifiaction.
[in]rangeStartOffsetPartial request start offset, 1 based. The default is 1. Files with zero length also start from 1 (the range is 1-0). Use zero or QWORD_MAX if range is not needed in which case the rangeStopOffset will be ignored.
[in]rangeStopOffsetPartial request stop offset, 1 based. Ignored if rangeStartOffset is zero. Files with zero length end at stop offset zero (the range is 1-0). Set to QWORD_MAX if stop offset is not known.
See also
IFileTransferEventsHandler
Returns
Result of the initiating

◆ Pause()

virtual ZDK::Shared::Result ZDK::IFileTransfer::Pause ( )
pure virtual

Pauses file transfer.

◆ Reject()

virtual ZDK::Shared::Result ZDK::IFileTransfer::Reject ( )
pure virtual

Reject file transfer request.

◆ RequestTrasnfer()

virtual ZDK::Shared::Result ZDK::IFileTransfer::RequestTrasnfer ( ZDK::Shared::String  peer,
ZDK::Shared::String  name,
int  size,
const char *  digest,
ZDK::Shared::String  mimeType,
ZDK::Shared::String  timeCreated,
ZDK::Shared::String  timeModified,
unsigned long long  rangeStartOffset,
unsigned long long  rangeStopOffset 
)
pure virtual

Request file transfer.

Parameters
[in]peerThe peer
[in]nameName to put in the request
[in]sizeFile size
[in]digestDigest octets in binary form. This parameter is ignored if the digestType is E_DIGEST_UNKNOWN
[in]mimeTypeMIME type of the file
[in]timeCreatedRFC 5322 date-time of file creation.
[in]timeModifiedThe RFC 5322 date-time of last file modifiaction.
[in]rangeStartOffsetPartial request start offset, 1 based. The default is 1. Files with zero length also start from 1 (the range is 1-0). Use zero or QWORD_MAX if range is not needed in which case the rangeStopOffset will be ignored.
[in]rangeStopOffsetPartial request stop offset, 1 based. Ignored if rangeStartOffset is zero. Files with zero length end at stop offset zero (the range is 1-0). Set to QWORD_MAX if stop offset is not known.
See also
IFileTransferEventsHandler
Returns
Result of the request

◆ Resume()

virtual ZDK::Shared::Result ZDK::IFileTransfer::Resume ( )
pure virtual

Resumes file transfer.

◆ SetSenderDataBuffer()

virtual ZDK::Shared::Result ZDK::IFileTransfer::SetSenderDataBuffer ( unsigned char *  data)
pure virtual

Set the sender data buffer.

Parameters
[in]dataThe buffer size
Returns
Result of the setting the buffer size

◆ SetStatusListener()

virtual void ZDK::IFileTransfer::SetStatusListener ( ZDK::Shared::FileTransferEventsHandler  value)
pure virtual

Set file transfer status listener.

Parameters
[in]valueThe file transfer handler
See also
IFileTransferEventsHandler

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