ソースを参照

update comments

Darien Raymond 8 年 前
コミット
4f27a07c29
1 ファイル変更4 行追加0 行削除
  1. 4 0
      proxy/proxy.go

+ 4 - 0
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)
 }