2018-11-20 17:51:25 -05:00
|
|
|
package quic
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
"io"
|
|
|
|
"net"
|
|
|
|
"time"
|
|
|
|
|
|
|
|
"github.com/lucas-clemente/quic-go/internal/handshake"
|
|
|
|
"github.com/lucas-clemente/quic-go/internal/protocol"
|
|
|
|
)
|
|
|
|
|
|
|
|
// The StreamID is the ID of a QUIC stream.
|
|
|
|
type StreamID = protocol.StreamID
|
|
|
|
|
|
|
|
// A VersionNumber is a QUIC version number.
|
|
|
|
type VersionNumber = protocol.VersionNumber
|
|
|
|
|
|
|
|
// A Cookie can be used to verify the ownership of the client address.
|
2018-11-23 11:04:53 -05:00
|
|
|
type Cookie struct {
|
|
|
|
RemoteAddr string
|
|
|
|
SentTime time.Time
|
|
|
|
}
|
2018-11-20 17:51:25 -05:00
|
|
|
|
|
|
|
// ConnectionState records basic details about the QUIC connection.
|
|
|
|
type ConnectionState = handshake.ConnectionState
|
|
|
|
|
|
|
|
// An ErrorCode is an application-defined error code.
|
|
|
|
type ErrorCode = protocol.ApplicationErrorCode
|
|
|
|
|
|
|
|
// Stream is the interface implemented by QUIC streams
|
|
|
|
type Stream interface {
|
|
|
|
// StreamID returns the stream ID.
|
|
|
|
StreamID() StreamID
|
|
|
|
// Read reads data from the stream.
|
|
|
|
// Read can be made to time out and return a net.Error with Timeout() == true
|
|
|
|
// after a fixed time limit; see SetDeadline and SetReadDeadline.
|
|
|
|
// If the stream was canceled by the peer, the error implements the StreamError
|
|
|
|
// interface, and Canceled() == true.
|
|
|
|
io.Reader
|
|
|
|
// Write writes data to the stream.
|
|
|
|
// Write can be made to time out and return a net.Error with Timeout() == true
|
|
|
|
// after a fixed time limit; see SetDeadline and SetWriteDeadline.
|
|
|
|
// If the stream was canceled by the peer, the error implements the StreamError
|
|
|
|
// interface, and Canceled() == true.
|
|
|
|
io.Writer
|
|
|
|
// Close closes the write-direction of the stream.
|
|
|
|
// Future calls to Write are not permitted after calling Close.
|
|
|
|
// It must not be called concurrently with Write.
|
|
|
|
// It must not be called after calling CancelWrite.
|
|
|
|
io.Closer
|
|
|
|
// CancelWrite aborts sending on this stream.
|
|
|
|
// It must not be called after Close.
|
|
|
|
// Data already written, but not yet delivered to the peer is not guaranteed to be delivered reliably.
|
|
|
|
// Write will unblock immediately, and future calls to Write will fail.
|
|
|
|
CancelWrite(ErrorCode) error
|
|
|
|
// CancelRead aborts receiving on this stream.
|
|
|
|
// It will ask the peer to stop transmitting stream data.
|
|
|
|
// Read will unblock immediately, and future Read calls will fail.
|
|
|
|
CancelRead(ErrorCode) error
|
|
|
|
// The context is canceled as soon as the write-side of the stream is closed.
|
|
|
|
// This happens when Close() is called, or when the stream is reset (either locally or remotely).
|
|
|
|
// Warning: This API should not be considered stable and might change soon.
|
|
|
|
Context() context.Context
|
|
|
|
// SetReadDeadline sets the deadline for future Read calls and
|
|
|
|
// any currently-blocked Read call.
|
|
|
|
// A zero value for t means Read will not time out.
|
|
|
|
SetReadDeadline(t time.Time) error
|
|
|
|
// SetWriteDeadline sets the deadline for future Write calls
|
|
|
|
// and any currently-blocked Write call.
|
|
|
|
// Even if write times out, it may return n > 0, indicating that
|
|
|
|
// some of the data was successfully written.
|
|
|
|
// A zero value for t means Write will not time out.
|
|
|
|
SetWriteDeadline(t time.Time) error
|
|
|
|
// SetDeadline sets the read and write deadlines associated
|
|
|
|
// with the connection. It is equivalent to calling both
|
|
|
|
// SetReadDeadline and SetWriteDeadline.
|
|
|
|
SetDeadline(t time.Time) error
|
2018-11-30 08:43:51 -05:00
|
|
|
|
|
|
|
HasMoreData() bool
|
2018-11-20 17:51:25 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// A ReceiveStream is a unidirectional Receive Stream.
|
|
|
|
type ReceiveStream interface {
|
|
|
|
// see Stream.StreamID
|
|
|
|
StreamID() StreamID
|
|
|
|
// see Stream.Read
|
|
|
|
io.Reader
|
|
|
|
// see Stream.CancelRead
|
|
|
|
CancelRead(ErrorCode) error
|
|
|
|
// see Stream.SetReadDealine
|
|
|
|
SetReadDeadline(t time.Time) error
|
2018-11-30 08:43:51 -05:00
|
|
|
|
|
|
|
HasMoreData() bool
|
2018-11-20 17:51:25 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// A SendStream is a unidirectional Send Stream.
|
|
|
|
type SendStream interface {
|
|
|
|
// see Stream.StreamID
|
|
|
|
StreamID() StreamID
|
|
|
|
// see Stream.Write
|
|
|
|
io.Writer
|
|
|
|
// see Stream.Close
|
|
|
|
io.Closer
|
|
|
|
// see Stream.CancelWrite
|
|
|
|
CancelWrite(ErrorCode) error
|
|
|
|
// see Stream.Context
|
|
|
|
Context() context.Context
|
|
|
|
// see Stream.SetWriteDeadline
|
|
|
|
SetWriteDeadline(t time.Time) error
|
|
|
|
}
|
|
|
|
|
|
|
|
// StreamError is returned by Read and Write when the peer cancels the stream.
|
|
|
|
type StreamError interface {
|
|
|
|
error
|
|
|
|
Canceled() bool
|
|
|
|
ErrorCode() ErrorCode
|
|
|
|
}
|
|
|
|
|
|
|
|
// A Session is a QUIC connection between two peers.
|
|
|
|
type Session interface {
|
|
|
|
// AcceptStream returns the next stream opened by the peer, blocking until one is available.
|
|
|
|
AcceptStream() (Stream, error)
|
|
|
|
// AcceptUniStream returns the next unidirectional stream opened by the peer, blocking until one is available.
|
|
|
|
AcceptUniStream() (ReceiveStream, error)
|
|
|
|
// OpenStream opens a new bidirectional QUIC stream.
|
|
|
|
// There is no signaling to the peer about new streams:
|
|
|
|
// The peer can only accept the stream after data has been sent on the stream.
|
2019-01-14 14:52:10 -05:00
|
|
|
// If the error is non-nil, it satisfies the net.Error interface.
|
|
|
|
// When reaching the peer's stream limit, err.Temporary() will be true.
|
2018-11-20 17:51:25 -05:00
|
|
|
OpenStream() (Stream, error)
|
|
|
|
// OpenStreamSync opens a new bidirectional QUIC stream.
|
2019-01-14 14:52:10 -05:00
|
|
|
// It blocks until a new stream can be opened.
|
|
|
|
// If the error is non-nil, it satisfies the net.Error interface.
|
2018-11-20 17:51:25 -05:00
|
|
|
OpenStreamSync() (Stream, error)
|
|
|
|
// OpenUniStream opens a new outgoing unidirectional QUIC stream.
|
2019-01-14 14:52:10 -05:00
|
|
|
// If the error is non-nil, it satisfies the net.Error interface.
|
|
|
|
// When reaching the peer's stream limit, Temporary() will be true.
|
2018-11-20 17:51:25 -05:00
|
|
|
OpenUniStream() (SendStream, error)
|
|
|
|
// OpenUniStreamSync opens a new outgoing unidirectional QUIC stream.
|
2019-01-14 14:52:10 -05:00
|
|
|
// It blocks until a new stream can be opened.
|
|
|
|
// If the error is non-nil, it satisfies the net.Error interface.
|
2018-11-20 17:51:25 -05:00
|
|
|
OpenUniStreamSync() (SendStream, error)
|
|
|
|
// LocalAddr returns the local address.
|
|
|
|
LocalAddr() net.Addr
|
|
|
|
// RemoteAddr returns the address of the peer.
|
|
|
|
RemoteAddr() net.Addr
|
|
|
|
// Close the connection.
|
|
|
|
io.Closer
|
|
|
|
// Close the connection with an error.
|
|
|
|
// The error must not be nil.
|
|
|
|
CloseWithError(ErrorCode, error) error
|
|
|
|
// The context is cancelled when the session is closed.
|
|
|
|
// Warning: This API should not be considered stable and might change soon.
|
|
|
|
Context() context.Context
|
|
|
|
// ConnectionState returns basic details about the QUIC connection.
|
|
|
|
// Warning: This API should not be considered stable and might change soon.
|
|
|
|
ConnectionState() ConnectionState
|
|
|
|
}
|
|
|
|
|
|
|
|
// Config contains all configuration data needed for a QUIC server or client.
|
|
|
|
type Config struct {
|
|
|
|
// The QUIC versions that can be negotiated.
|
|
|
|
// If not set, it uses all versions available.
|
|
|
|
// Warning: This API should not be considered stable and will change soon.
|
|
|
|
Versions []VersionNumber
|
2018-11-23 11:04:53 -05:00
|
|
|
// The length of the connection ID in bytes.
|
2018-11-20 17:51:25 -05:00
|
|
|
// It can be 0, or any value between 4 and 18.
|
|
|
|
// If not set, the interpretation depends on where the Config is used:
|
|
|
|
// If used for dialing an address, a 0 byte connection ID will be used.
|
|
|
|
// If used for a server, or dialing on a packet conn, a 4 byte connection ID will be used.
|
|
|
|
// When dialing on a packet conn, the ConnectionIDLength value must be the same for every Dial call.
|
|
|
|
ConnectionIDLength int
|
|
|
|
// HandshakeTimeout is the maximum duration that the cryptographic handshake may take.
|
|
|
|
// If the timeout is exceeded, the connection is closed.
|
|
|
|
// If this value is zero, the timeout is set to 10 seconds.
|
|
|
|
HandshakeTimeout time.Duration
|
|
|
|
// IdleTimeout is the maximum duration that may pass without any incoming network activity.
|
|
|
|
// This value only applies after the handshake has completed.
|
|
|
|
// If the timeout is exceeded, the connection is closed.
|
|
|
|
// If this value is zero, the timeout is set to 30 seconds.
|
|
|
|
IdleTimeout time.Duration
|
|
|
|
// AcceptCookie determines if a Cookie is accepted.
|
|
|
|
// It is called with cookie = nil if the client didn't send an Cookie.
|
|
|
|
// If not set, it verifies that the address matches, and that the Cookie was issued within the last 24 hours.
|
|
|
|
// This option is only valid for the server.
|
|
|
|
AcceptCookie func(clientAddr net.Addr, cookie *Cookie) bool
|
|
|
|
// MaxReceiveStreamFlowControlWindow is the maximum stream-level flow control window for receiving data.
|
|
|
|
// If this value is zero, it will default to 1 MB for the server and 6 MB for the client.
|
|
|
|
MaxReceiveStreamFlowControlWindow uint64
|
|
|
|
// MaxReceiveConnectionFlowControlWindow is the connection-level flow control window for receiving data.
|
|
|
|
// If this value is zero, it will default to 1.5 MB for the server and 15 MB for the client.
|
|
|
|
MaxReceiveConnectionFlowControlWindow uint64
|
|
|
|
// MaxIncomingStreams is the maximum number of concurrent bidirectional streams that a peer is allowed to open.
|
|
|
|
// If not set, it will default to 100.
|
|
|
|
// If set to a negative value, it doesn't allow any bidirectional streams.
|
|
|
|
MaxIncomingStreams int
|
|
|
|
// MaxIncomingUniStreams is the maximum number of concurrent unidirectional streams that a peer is allowed to open.
|
|
|
|
// If not set, it will default to 100.
|
|
|
|
// If set to a negative value, it doesn't allow any unidirectional streams.
|
|
|
|
MaxIncomingUniStreams int
|
|
|
|
// KeepAlive defines whether this peer will periodically send PING frames to keep the connection alive.
|
|
|
|
KeepAlive bool
|
|
|
|
}
|
|
|
|
|
|
|
|
// A Listener for incoming QUIC connections
|
|
|
|
type Listener interface {
|
|
|
|
// Close the server, sending CONNECTION_CLOSE frames to each peer.
|
|
|
|
Close() error
|
|
|
|
// Addr returns the local network addr that the server is listening on.
|
|
|
|
Addr() net.Addr
|
|
|
|
// Accept returns new sessions. It should be called in a loop.
|
|
|
|
Accept() (Session, error)
|
|
|
|
}
|