Overview.aml 1.1 KB

1234567891011121314151617
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <topic id="f4ce1bdd-403f-45ec-a622-86c05a4bd913" revisionNumber="1">
  3. <developerHowToDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
  4. <introduction>
  5. <para>Port forwarding supported for remote and local ports.</para>
  6. <para>Multiple port can be forwarded simultaneously.</para>
  7. <para>To start port forwarding you need to create an <codeEntityReference>T:Renci.SshNet.ForwardedPortLocal</codeEntityReference> or <codeEntityReference>T:Renci.SshNet.ForwardedPortRemote </codeEntityReference> object.
  8. Once port object is created you can use <codeEntityReference>M:Renci.SshNet.ForwardedPort.Start</codeEntityReference> start port forwarding or <codeEntityReference>M:Renci.SshNet.ForwardedPort.Stop</codeEntityReference> to stop it.
  9. </para>
  10. <alert class="tip">
  11. <para>An exception can be thrown while port is forwarded. When this happens an <codeEntityReference>E:Renci.SshNet.ForwardedPort.Exception</codeEntityReference> event is raised.</para>
  12. </alert>
  13. </introduction>
  14. </developerHowToDocument>
  15. </topic>