From 4f27a07c2969e23f867ae1a012959f926bad0910 Mon Sep 17 00:00:00 2001 From: Darien Raymond Date: Mon, 13 Feb 2017 13:13:21 +0100 Subject: [PATCH] update comments --- proxy/proxy.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/proxy/proxy.go b/proxy/proxy.go index ce57472cc..67b7c3c86 100644 --- a/proxy/proxy.go +++ b/proxy/proxy.go @@ -12,17 +12,21 @@ import ( // An Inbound processes inbound connections. type Inbound interface { + // Network returns a list of network that this inbound supports. Connections with not-supported networks will not be passed into Process(). Network() net.NetworkList + // Process processes a connection of given network. If necessary, the Inbound can dispatch the connection to an Outbound. Process(context.Context, net.Network, internet.Connection, dispatcher.Interface) error } // An Outbound process outbound connections. type Outbound interface { + // Process processes the given connection. The given dialer may be used to dial a system outbound connection. Process(context.Context, ray.OutboundRay, Dialer) error } // Dialer is used by OutboundHandler for creating outbound connections. type Dialer interface { + // Dial dials a system connection to the given destination. Dial(ctx context.Context, destination net.Destination) (internet.Connection, error) }