var (
// ErrProtocol is a general error in the handling the protocol.
ErrProtocol = errors.New("protocol error")
// ErrClosed is returned by client methods when the underlying connection is
// closed.
ErrClosed = errors.New("ttrpc: closed")
// ErrServerClosed is returned when the Server has closed its connection.
ErrServerClosed = errors.New("ttrpc: server closed")
// ErrStreamClosed is when the streaming connection is closed.
ErrStreamClosed = errors.New("ttrpc: stream closed")
)
var File_github_com_containerd_ttrpc_request_proto protoreflect.FileDescriptor
func GetMetadataValue(ctx context.Context, name string) (string, bool)
GetMetadataValue gets a specific metadata value by name from context.Context
func WithMetadata(ctx context.Context, md MD) context.Context
WithMetadata attaches metadata map to a context.Context
Client for a ttrpc server
type Client struct {
// contains filtered or unexported fields
}
func NewClient(conn net.Conn, opts ...ClientOpts) *Client
NewClient creates a new ttrpc client using the given connection
func (c *Client) Call(ctx context.Context, service, method string, req, resp interface{}) error
Call makes a unary request and returns with response
func (c *Client) Close() error
Close closes the ttrpc connection and underlying connection
func (c *Client) NewStream(ctx context.Context, desc *StreamDesc, service, method string, req interface{}) (ClientStream, error)
NewStream creates a new stream with the given stream descriptor to the specified service and method. If not a streaming client, the request object may be provided.
func (c *Client) UserOnCloseWait(ctx context.Context) error
UserOnCloseWait is used to blocks untils the user's on-close callback finishes.
ClientOpts configures a client
type ClientOpts func(c *Client)
func WithOnClose(onClose func()) ClientOpts
WithOnClose sets the close func whenever the client's Close() method is called
func WithUnaryClientInterceptor(i UnaryClientInterceptor) ClientOpts
WithUnaryClientInterceptor sets the provided client interceptor
ClientStream is used to send or recv messages on the underlying stream
type ClientStream interface {
CloseSend() error
SendMsg(m interface{}) error
RecvMsg(m interface{}) error
}
Handshaker defines the interface for connection handshakes performed on the server or client when first connecting.
type Handshaker interface {
// Handshake should confirm or decorate a connection that may be incoming
// to a server or outgoing from a client.
//
// If this returns without an error, the caller should use the connection
// in place of the original connection.
//
// The second return value can contain credential specific data, such as
// unix socket credentials or TLS information.
//
// While we currently only have implementations on the server-side, this
// interface should be sufficient to implement similar handshakes on the
// client-side.
Handshake(ctx context.Context, conn net.Conn) (net.Conn, interface{}, error)
}
Invoker invokes the client's request and response from the ttrpc server
type Invoker func(context.Context, *Request, *Response) error
type KeyValue struct {
Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func (*KeyValue) Descriptor() ([]byte, []int)
Deprecated: Use KeyValue.ProtoReflect.Descriptor instead.
func (x *KeyValue) GetKey() string
func (x *KeyValue) GetValue() string
func (*KeyValue) ProtoMessage()
func (x *KeyValue) ProtoReflect() protoreflect.Message
func (x *KeyValue) Reset()
func (x *KeyValue) String() string
MD is the user type for ttrpc metadata
type MD map[string][]string
func GetMetadata(ctx context.Context) (MD, bool)
GetMetadata retrieves metadata from context.Context (previously attached with WithMetadata)
func (m MD) Append(key string, values ...string)
Append appends additional values to the given key.
func (m MD) Get(key string) ([]string, bool)
Get returns the metadata for a given key when they exist. If there is no metadata, a nil slice and false are returned.
func (m MD) Set(key string, values ...string)
Set sets the provided values for a given key. The values will overwrite any existing values. If no values provided, a key will be deleted.
type Method func(ctx context.Context, unmarshal func(interface{}) error) (interface{}, error)
type Request struct {
Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
Method string `protobuf:"bytes,2,opt,name=method,proto3" json:"method,omitempty"`
Payload []byte `protobuf:"bytes,3,opt,name=payload,proto3" json:"payload,omitempty"`
TimeoutNano int64 `protobuf:"varint,4,opt,name=timeout_nano,json=timeoutNano,proto3" json:"timeout_nano,omitempty"`
Metadata []*KeyValue `protobuf:"bytes,5,rep,name=metadata,proto3" json:"metadata,omitempty"`
// contains filtered or unexported fields
}
func (*Request) Descriptor() ([]byte, []int)
Deprecated: Use Request.ProtoReflect.Descriptor instead.
func (x *Request) GetMetadata() []*KeyValue
func (x *Request) GetMethod() string
func (x *Request) GetPayload() []byte
func (x *Request) GetService() string
func (x *Request) GetTimeoutNano() int64
func (*Request) ProtoMessage()
func (x *Request) ProtoReflect() protoreflect.Message
func (x *Request) Reset()
func (x *Request) String() string
type Response struct {
Status *status.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
Payload []byte `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"`
// contains filtered or unexported fields
}
func (*Response) Descriptor() ([]byte, []int)
Deprecated: Use Response.ProtoReflect.Descriptor instead.
func (x *Response) GetPayload() []byte
func (x *Response) GetStatus() *status.Status
func (*Response) ProtoMessage()
func (x *Response) ProtoReflect() protoreflect.Message
func (x *Response) Reset()
func (x *Response) String() string
type Server struct {
// contains filtered or unexported fields
}
func NewServer(opts ...ServerOpt) (*Server, error)
func (s *Server) Close() error
Close the server without waiting for active connections.
func (s *Server) Register(name string, methods map[string]Method)
Register registers a map of methods to method handlers TODO: Remove in 2.0, does not support streams
func (s *Server) RegisterService(name string, desc *ServiceDesc)
func (s *Server) Serve(ctx context.Context, l net.Listener) error
func (s *Server) Shutdown(ctx context.Context) error
ServerOpt for configuring a ttrpc server
type ServerOpt func(*serverConfig) error
func WithServerHandshaker(handshaker Handshaker) ServerOpt
WithServerHandshaker can be passed to NewServer to ensure that the handshaker is called before every connection attempt.
Only one handshaker is allowed per server.
func WithUnaryServerInterceptor(i UnaryServerInterceptor) ServerOpt
WithUnaryServerInterceptor sets the provided interceptor on the server
type ServiceDesc struct {
Methods map[string]Method
Streams map[string]Stream
}
type Stream struct {
Handler StreamHandler
StreamingClient bool
StreamingServer bool
}
type StreamClientInterceptor func(context.Context)
StreamDesc describes the stream properties, whether the stream has a streaming client, a streaming server, or both
type StreamDesc struct {
StreamingClient bool
StreamingServer bool
}
type StreamHandler func(context.Context, StreamServer) (interface{}, error)
type StreamServer interface {
SendMsg(m interface{}) error
RecvMsg(m interface{}) error
}
StreamServerInfo provides information about the server request
type StreamServerInfo struct {
FullMethod string
StreamingClient bool
StreamingServer bool
}
type StreamServerInterceptor func(context.Context, StreamServer, *StreamServerInfo, StreamHandler) (interface{}, error)
type StringList struct {
List []string `protobuf:"bytes,1,rep,name=list,proto3" json:"list,omitempty"`
// contains filtered or unexported fields
}
func (*StringList) Descriptor() ([]byte, []int)
Deprecated: Use StringList.ProtoReflect.Descriptor instead.
func (x *StringList) GetList() []string
func (*StringList) ProtoMessage()
func (x *StringList) ProtoReflect() protoreflect.Message
func (x *StringList) Reset()
func (x *StringList) String() string
UnaryClientInfo provides information about the client request
type UnaryClientInfo struct {
FullMethod string
}
UnaryClientInterceptor specifies the interceptor function for client request/response
type UnaryClientInterceptor func(context.Context, *Request, *Response, *UnaryClientInfo, Invoker) error
UnaryServerInfo provides information about the server request
type UnaryServerInfo struct {
FullMethod string
}
UnaryServerInterceptor specifies the interceptor function for server request/response
type UnaryServerInterceptor func(context.Context, Unmarshaler, *UnaryServerInfo, Method) (interface{}, error)
type UnixCredentialsFunc func(*unix.Ucred) error
func UnixSocketRequireRoot() UnixCredentialsFunc
func UnixSocketRequireSameUser() UnixCredentialsFunc
UnixSocketRequireSameUser resolves the current effective unix user and returns a UnixCredentialsFunc that will validate incoming unix connections against the current credentials.
This is useful when using abstract sockets that are accessible by all users.
func UnixSocketRequireUidGid(uid, gid int) UnixCredentialsFunc
UnixSocketRequireUidGid requires specific *effective* UID/GID, rather than the real UID/GID.
For example, if a daemon binary is owned by the root (UID 0) with SUID bit but running as an unprivileged user (UID 1001), the effective UID becomes 0, and the real UID becomes 1001. So calling this function with uid=0 allows a connection from effective UID 0 but rejects a connection from effective UID 1001.
See socket(7), SO_PEERCRED: "The returned credentials are those that were in effect at the time of the call to connect(2) or socketpair(2)."
func (fn UnixCredentialsFunc) Handshake(_ context.Context, conn net.Conn) (net.Conn, interface{}, error)
Unmarshaler contains the server request data and allows it to be unmarshaled into a concrete type
type Unmarshaler func(interface{}) error
| Name | Synopsis |
|---|---|
| .. | |
| cmd | |
| protoc-gen-go-ttrpc | |
| protoc-gen-gogottrpc | |
| example | Package example demonstrates a lightweight protobuf service. |
| cmd | |
| integration | |
| streaming | Code generated by protoc-gen-go-ttrpc. |
| plugin | |