SftpHandler Class

[C++]

class SftpHandler : public HandlerBase (.. public RefCountable, public NoCopy)
{
public:
  bool Success() const;
  SftpErr GetError() const;

protected:
  virtual void OnStart();
  virtual void OnDone();
  virtual void OnSuccess();
  virtual void OnError(SftpErr const& error);
}

[C#]

public class SftpHandler : IDisposable, HandlerBase (.. WaitImpl)
{
  public bool Success { get; }
  public SftpErr GetError();
  
  public event StartEventHandler OnStart;
  public event DoneEventHandler OnDone;
  public event SuccessEventHandler OnSuccess;
  public event SftpErrorEventHandler OnError;
  
  public override sealed bool IsDisposed { get; }
  public override sealed void Dispose();
}

Members

General

• Success: Request completed successfully?
• GetError: Returns a SftpErr.

Overrides and Events

• OnStart: The first override/event being invoked for a request. *
• OnDone: The last override/event being invoked for a request. *
• OnSuccess: Invoked when the request was successful.
• OnError: Invoked for a failed request.
  Parameters:
  • error: See GetError().

[.NET] Disposing

• IsDisposed: Is the object disposed?
• Dispose: Release all resources used by the object.

Remarks

SftpHandler is a base class which must be derived to use. Either derive and implement your own OnDone() method, or use pre-made derived classes SftpEvent or SftpMsg (for Win32 graphical applications). If you use SftpEvent, call WaitDone() or wait for GetDoneEvent() before checking the result.

This handler is used with with a variety of ClientSftpChannel requests.

* [C++] Always call the base class implementation from your override.