Back to FlowSsh Documentation

RealPathHandler Class

[C++]

class RealPathHandler : public RefCountable, public NoCopy, public HandlerBase
{
public:
  bool Success() const;
  std::wstring GetRealPath() const;
  SftpErr GetError() const;

protected:
  virtual void OnStart();
  virtual void OnDone();
  virtual void OnRealPath(std::wstring const& realPath);
  virtual void OnError(SftpErr const& error);
}

[C#]

public class RealPathHandler : IDisposable (.. : WaitImpl)
{
  public bool Success { get; }
  public string GetRealPath();
  public SftpErr GetError();
  
  public event StartEventHandler OnStart;
  public event DoneEventHandler OnDone;
  public event RealPathEventHandler OnRealPath;
  public event SftpErrorEventHandler OnError;
  
  public override sealed bool IsDisposed { get; }
  public override sealed void Dispose();
}

Members

General

  • Success: Request completed successfully?
  • GetRealPath: Returns the resulting absolute path with a leading slash ("/").
  • 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. *
  • OnRealPath: Invoked to inform you about the resulting absolute path.
    Parameters:
    • realPath: See GetRealPath().
  • 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

This handler is used with with the [ClientSftpChannel]RealPath request.

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