mirror of
https://github.com/apple/swift-nio-extras.git
synced 2025-06-02 02:56:03 +08:00
dabef818d3
Motivation: An index page ties all the other documentation together Modifications: Add index pages for the library targets. Correct a few minor errors in the main docs. Result: A more joined up documentation experience.
36 lines
732 B
Markdown
36 lines
732 B
Markdown
# ``NIOSOCKS``
|
|
|
|
SOCKS v5 protocol implementation
|
|
|
|
## Overview
|
|
|
|
An implementation of SOCKS v5 protocol. See [RFC1928](https://www.rfc-editor.org/rfc/rfc1928).
|
|
|
|
Add the appropriate channel handler to the start of your channel pipeline to use this protocol.
|
|
|
|
For an example see the NIOSOCKSClient target.
|
|
|
|
## Topics
|
|
|
|
### Channel Handlers
|
|
- ``SOCKSClientHandler``
|
|
- ``SOCKSServerHandshakeHandler``
|
|
|
|
### Client Messages
|
|
- ``ClientMessage``
|
|
- ``ClientGreeting``
|
|
- ``SOCKSRequest``
|
|
|
|
### Server Messages
|
|
- ``ServerMessage``
|
|
- ``SelectedAuthenticationMethod``
|
|
- ``SOCKSResponse``
|
|
|
|
### Supporting Types
|
|
- ``AuthenticationMethod``
|
|
- ``SOCKSServerReply``
|
|
- ``SOCKSCommand``
|
|
- ``SOCKSAddress``
|
|
- ``SOCKSProxyEstablishedEvent``
|
|
- ``SOCKSError``
|