forked from minekube/connect
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support bidirectional streaming using WebSockets (minekube#2)
- Loading branch information
1 parent
98f4e78
commit 0207f68
Showing
27 changed files
with
925 additions
and
94 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| package connect | ||
|
|
||
| import ( | ||
| "context" | ||
| "net" | ||
|
|
||
| "go.minekube.com/connect/internal/ctxkey" | ||
| ) | ||
|
|
||
| // Well-known headers / metadata keys | ||
| const ( | ||
| MDPrefix = "connect-" // The prefix of Connect metadata keys. | ||
| MDSession = MDPrefix + "session" // Metadata key specifying the session id for a Tunnel. | ||
| MDEndpoint = MDPrefix + "endpoint" // Metadata key specifying the watching Endpoint. | ||
| ) | ||
|
|
||
| // Tunnel represents an outbound only tunnel initiated by | ||
| // an Endpoint for a specific SessionProposal. | ||
| type Tunnel net.Conn | ||
|
|
||
| // Tunneler creates a Tunnel. | ||
| type Tunneler interface { | ||
| Tunnel(context.Context) (Tunnel, error) | ||
| } | ||
|
|
||
| // Watcher registers the calling endpoint and watches for sessions | ||
| // proposed by the WatchService. To stop watching cancel the context. | ||
| // If ReceiveProposal returns a non-nil non-EOF error Watch returns it. | ||
| type Watcher interface { | ||
| Watch(context.Context, ReceiveProposal) error | ||
| } | ||
|
|
||
| // ReceiveProposal is called when Watcher receives a SessionProposal. | ||
| type ReceiveProposal func(proposal SessionProposal) error | ||
|
|
||
| // SessionProposal specifies an incoming session proposal. | ||
| // Use the Session to create the connection tunnel or reject the session with an optional reason. | ||
| type SessionProposal interface { | ||
| Session() *Session // The session proposed to connect to the Endpoint. | ||
| Reject(context.Context, *RejectionReason) error // Rejects the session proposal with an optional reason. | ||
| } | ||
|
|
||
| // Endpoint is an endpoint that listens for | ||
| // sessions to either reject them or establish | ||
| // a tunnel for receiving the connection. | ||
| type Endpoint interface { | ||
| Watcher | ||
| Tunneler | ||
| } | ||
|
|
||
| // TunnelListener is a network listener for tunnel connections. | ||
| type TunnelListener interface { | ||
| AcceptTunnel(context.Context, Tunnel) error | ||
| } | ||
|
|
||
| // EndpointListener is a network listener for endpoint watches. | ||
| type EndpointListener interface { | ||
| AcceptEndpoint(context.Context, EndpointWatch) error | ||
| } | ||
|
|
||
| // EndpointWatch is a watching Endpoint. | ||
| type EndpointWatch interface { | ||
| // Propose proposes a session to the Endpoint. | ||
| // The Endpoint either rejects the proposal or initiates | ||
| // a Tunnel to receive the session connection. | ||
| Propose(context.Context, *Session) error | ||
| Rejections() <-chan *SessionRejection // Rejections receives rejected session proposals from the Endpoint. | ||
| } | ||
|
|
||
| // Listener listens for watching endpoints and tunnel connections from endpoints. | ||
| type Listener interface { | ||
| EndpointListener | ||
| TunnelListener | ||
| } | ||
|
|
||
| // TunnelOptions are options for Tunneler and TunnelListener. | ||
| // Use WithTunnelOptions to propagate TunnelOptions in context. | ||
| type TunnelOptions struct { | ||
| // LocalAddr fakes the local address of the Tunnel when specified. | ||
| // | ||
| // If this TunnelOptions destine to Tunneler | ||
| // it is recommended to use the Endpoint address/name. | ||
| // | ||
| // If this TunnelOptions destine to TunnelListener | ||
| // it is recommended to use the underlying network listener address. | ||
| LocalAddr net.Addr | ||
| // RemoteAddr fakes the remote address of the Tunnel when specified. | ||
| // | ||
| // If this TunnelOptions destine to Tunneler | ||
| // it is recommended to use the underlying connection remote address. | ||
| // | ||
| // If this TunnelOptions destine to TunnelListener | ||
| // it is recommended to use the Endpoint address/name. | ||
| RemoteAddr net.Addr // It is recommended to use the player address. | ||
| } | ||
|
|
||
| // WithTunnelOptions stores TunnelOptions in a context. | ||
| func WithTunnelOptions(ctx context.Context, opts TunnelOptions) context.Context { | ||
| return context.WithValue(ctx, ctxkey.TunnelOptions{}, opts) | ||
| } | ||
|
|
||
| // Addr is an address in the "connect" network. | ||
| type Addr string | ||
|
|
||
| func (a Addr) String() string { return string(a) } | ||
| func (a Addr) Network() string { return "connect" } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.