comments

app/dispatcher/default.go

@@ -106,6 +106,7 @@ func NewDefaultDispatcher(ctx context.Context, config *Config) (*DefaultDispatch
 	return d, nil
 }
 
+// Type implements common.HasType.
 func (*DefaultDispatcher) Type() interface{} {
 	return routing.DispatcherType()
 }

common/session/session.go

@@ -24,6 +24,8 @@ func NewID() ID {
 	}
 }
 
+// ExportIDToError transfers session.ID into an error object, for logging purpose.
+// This can be used with error.WriteToLog().
 func ExportIDToError(ctx context.Context) errors.ExportOption {
 	id := IDFromContext(ctx)
 	return func(h *errors.ExportOptionHolder) {
@@ -31,16 +33,24 @@ func ExportIDToError(ctx context.Context) errors.ExportOption {
 	}
 }
 
+// Inbound is the metadata of an inbound connection.
 type Inbound struct {
+	// Source address of the inbound connection.
 	Source net.Destination
+	// Getaway address
 	Gateway net.Destination
+	// Tag of the inbound proxy that handles the connection.
 	Tag string
 	// User is the user that authencates for the inbound. May be nil if the protocol allows anounymous traffic.
 	User *protocol.MemoryUser
 }
 
+// Outbound is the metadata of an outbound connection.
 type Outbound struct {
+	// Target address of the outbound connection.
 	Target net.Destination
+	// Gateway address
 	Gateway net.Address
+	// ResolvedIPs is the resolved IP addresses, if the Targe is a domain address.
 	ResolvedIPs []net.IP
 }