client

type CallOption func(*CallOptions)

type CallOptions struct {
	// Retries specifies a retry limit before a call actually fails.
	Retries int
	// CodecBuilder specifies a function to create a codec.
	CodecBuilder codec.Builder
}

type Client interface {
	// Init initializes the client using the given optional functions.
	// By default, the DefaultOptions will be used to create the client.
	Init(...Option)
	// Connect creates a virtual connection to a service. Note that only
	// the first call will open a new connection before which is closed.
	Connect(string) (Conn, error)
	// Stream returns a stream to a service endpoint. This method calls
	// Open to get a virtual connection in which the stream works.
	Stream(*Request, ...CallOption) (stream.Stream, error)
	// Invoke simply wraps Stream to make an unary call to the service.
	// TODO: Does it take too much to make such unary call by that??
	Invoke(*Request, any, any, ...CallOption) error
}

type Conn interface {
	// Open opens a stream to a specific service endpoint.
	Open(*http.Request, codec.Builder) (stream.Stream, error)
	// Close closes the virtual connection itself.
	Close() error
}

type Option func(*Options)

type Options struct {
	// Network specifies the network of the client itself.
	Network string
	// TLSConfig specifies the TLS configuration for dialer.
	TLSConfig *tls.Config
	// Timeout specifies a time limit for streams made by the client.
	Timeout time.Duration
	// Transport specifies a transport provider for communication.
	Transport transport.Transport
	// Registry specifies registry for service discovery.
	Registry registry.Registry
	// Backoff specifies a backoff implementation for retries.
	Backoff backoff.Backoff
	// Breaker specifies a circuit breaker builder.
	Breaker breaker.Builder
	// Selector specifies node selector builder.
	Selector selector.Builder
}

type Request struct {
	// Service specifies which service to connect to.
	Service string
	// Endpoint specifies which endpoint of the service to call.
	Endpoint string
	// Context is used for timing out the call. If nil, a todo context will be used.
	Context context.Context
}