mirror of https://github.com/apple/swift-nio-extras.git synced 2025-05-14 00:42:41 +08:00

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.

2022-08-12 07:31:17 -07:00

732 B

Raw Blame History

`NIOSOCKS`

SOCKS v5 protocol implementation

Overview

An implementation of SOCKS v5 protocol. See 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

732 B Raw Blame History

NIOSOCKS