func ContextErr(errerror)error

func GetConnection(ctxcontext.Context)net.Conn

func ParseDialTarget(targetstring) (string,string)

func SetConnection(ctxcontext.Context, connnet.Conn)context.Context

type CallHdr struct {// Host specifies the peer's host.Hoststring// Method specifies the operation to perform.Methodstring// SendCompress specifies the compression algorithm applied on// outbound message.SendCompressstring// Creds specifies credentials.PerRPCCredentials for a call.Credscredentials.PerRPCCredentials// ContentSubtype specifies the content-subtype for a request. For example, a// content-subtype of "proto" will result in a content-type of// "application/grpc+proto". The value of ContentSubtype must be all// lowercase, otherwise the behavior is undefined. See//https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests// for more details.ContentSubtypestringPreviousAttemptsint// value of grpc-previous-rpc-attempts header to setDoneFunc func()// called when the stream is finished// Authority is used to explicitly override the `:authority` header. If set,// this value takes precedence over the Host field and will be used as the// value for the `:authority` header.Authoritystring}

type ClientStream struct {Stream// Embed for common stream functionality.// contains filtered or unexported fields}

func (*ClientStream)BytesReceived¶added inv1.69.0

func (s *ClientStream) BytesReceived()bool

BytesReceived indicates whether any bytes have been received on this stream.

func (*ClientStream)Close¶added inv1.69.0

func (s *ClientStream) Close(errerror)

Close closes the stream and propagates err to any readers.

func (*ClientStream)Done¶added inv1.69.0

func (s *ClientStream) Done() <-chan struct{}

Done returns a channel which is closed when it receives the final statusfrom the server.

func (*ClientStream)Header¶added inv1.69.0

func (s *ClientStream) Header() (metadata.MD,error)

Header returns the header metadata of the stream. Acquires the key-valuepairs of header metadata once it is available. It blocks until i) themetadata is ready or ii) there is no header metadata or iii) the stream iscanceled/expired.

func (*ClientStream)Read¶added inv1.69.0

func (s *ClientStream) Read(nint) (mem.BufferSlice,error)

Read reads an n byte message from the input stream.

func (*ClientStream)RecvCompress¶added inv1.69.0

func (s *ClientStream) RecvCompress()string

RecvCompress returns the compression algorithm applied to the inboundmessage. It is empty string if there is no compression applied.

func (*ClientStream)Status¶added inv1.69.0

func (s *ClientStream) Status() *status.Status

Status returns the status received from the server.Status can be read safely only after the stream has ended,that is, after Done() is closed.

func (*ClientStream)TrailersOnly¶added inv1.69.0

func (s *ClientStream) TrailersOnly()bool

TrailersOnly blocks until a header or trailers-only frame is received andthen returns true if the stream was trailers-only. If the stream endsbefore headers are received, returns true, nil.

func (*ClientStream)Unprocessed¶added inv1.69.0

func (s *ClientStream) Unprocessed()bool

Unprocessed indicates whether the server did not process this stream --i.e. it sent a refused stream or GOAWAY including this stream ID.

func (*ClientStream)Write¶added inv1.69.0

func (s *ClientStream) Write(hdr []byte, datamem.BufferSlice, opts *WriteOptions)error

Write writes the hdr and data bytes to the output stream.

type ClientTransport interface {// Close tears down this transport. Once it returns, the transport// should not be accessed any more. The caller must make sure this// is called only once.Close(errerror)// GracefulClose starts to tear down the transport: the transport will stop// accepting new RPCs and NewStream will return error. Once all streams are// finished, the transport will close.//// It does not block.GracefulClose()// NewStream creates a Stream for an RPC.NewStream(ctxcontext.Context, callHdr *CallHdr) (*ClientStream,error)// Error returns a channel that is closed when some I/O error// happens. Typically the caller should have a goroutine to monitor// this in order to take action (e.g., close the current transport// and create a new one) in error case. It should not return nil// once the transport is initiated.Error() <-chan struct{}// GoAway returns a channel that is closed when ClientTransport// receives the draining signal from the server (e.g., GOAWAY frame in// HTTP/2).GoAway() <-chan struct{}// GetGoAwayReason returns the reason why GoAway frame was received, along// with a human readable string with debug info.GetGoAwayReason() (GoAwayReason,string)// RemoteAddr returns the remote network address.RemoteAddr()net.Addr}

funcNewHTTP2Client¶added inv1.69.0

func NewHTTP2Client(connectCtx, ctxcontext.Context, addrresolver.Address, optsConnectOptions, onClose func(GoAwayReason)) (_ClientTransport, errerror)

NewHTTP2Client constructs a connected ClientTransport to addr based on HTTP2and starts to receive messages on it. Non-nil error returns if constructionfails.

type ConnectOptions struct {// UserAgent is the application user agent.UserAgentstring// Dialer specifies how to dial a network address.Dialer func(context.Context,string) (net.Conn,error)// FailOnNonTempDialError specifies if gRPC fails on non-temporary dial errors.FailOnNonTempDialErrorbool// PerRPCCredentials stores the PerRPCCredentials required to issue RPCs.PerRPCCredentials []credentials.PerRPCCredentials// TransportCredentials stores the Authenticator required to setup a client// connection. Only one of TransportCredentials and CredsBundle is non-nil.TransportCredentialscredentials.TransportCredentials// CredsBundle is the credentials bundle to be used. Only one of// TransportCredentials and CredsBundle is non-nil.CredsBundlecredentials.Bundle// KeepaliveParams stores the keepalive parameters.KeepaliveParamskeepalive.ClientParameters// StatsHandlers stores the handler for stats.StatsHandlers []stats.Handler// InitialWindowSize sets the initial window size for a stream.InitialWindowSizeint32// InitialConnWindowSize sets the initial window size for a connection.InitialConnWindowSizeint32// WriteBufferSize sets the size of write buffer which in turn determines how much data can be batched before it's written on the wire.WriteBufferSizeint// ReadBufferSize sets the size of read buffer, which in turn determines how much data can be read at most for one read syscall.ReadBufferSizeint// SharedWriteBuffer indicates whether connections should reuse write bufferSharedWriteBufferbool// ChannelzParent sets the addrConn id which initiated the creation of this client transport.ChannelzParent *channelz.SubChannel// MaxHeaderListSize sets the max (uncompressed) size of header list that is prepared to be received.MaxHeaderListSize *uint32// The mem.BufferPool to use when reading/writing to the wire.BufferPoolmem.BufferPool// StaticWindowSize controls whether dynamic window sizing is enabled.StaticWindowSizebool}

type ConnectionError struct {Descstring// contains filtered or unexported fields}

func (ConnectionError)Error¶

func (eConnectionError) Error()string

func (ConnectionError)Origin¶

func (eConnectionError) Origin()error

Origin returns the original error of this connection error.

func (ConnectionError)Temporary¶

func (eConnectionError) Temporary()bool

Temporary indicates if this connection error is temporary or fatal.

func (ConnectionError)Unwrap¶added inv1.45.0

func (eConnectionError) Unwrap()error

Unwrap returns the original error of this connection error or nil when theorigin is nil.

type GoAwayReasonuint8

type NewStreamError struct {ErrerrorAllowTransparentRetrybool}

func (NewStreamError)Error¶added inv1.40.0

func (eNewStreamError) Error()string

type ServerConfig struct {MaxStreamsuint32ConnectionTimeouttime.DurationCredentialscredentials.TransportCredentialsInTapHandletap.ServerInHandleStatsHandlerstats.HandlerKeepaliveParamskeepalive.ServerParametersKeepalivePolicykeepalive.EnforcementPolicyInitialWindowSizeint32InitialConnWindowSizeint32WriteBufferSizeintReadBufferSizeintSharedWriteBufferboolChannelzParent        *channelz.ServerMaxHeaderListSize     *uint32HeaderTableSize       *uint32BufferPoolmem.BufferPoolStaticWindowSizebool}

type ServerStream struct {Stream// Embed for common stream functionality.// contains filtered or unexported fields}

func (*ServerStream)ClientAdvertisedCompressors¶added inv1.69.0

func (s *ServerStream) ClientAdvertisedCompressors() []string

ClientAdvertisedCompressors returns the compressor names advertised by theclient via grpc-accept-encoding header.

func (*ServerStream)ContentSubtype¶added inv1.69.0

func (s *ServerStream) ContentSubtype()string

ContentSubtype returns the content-subtype for a request. For example, acontent-subtype of "proto" will result in a content-type of"application/grpc+proto". This will always be lowercase. Seehttps://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests formore details.

func (*ServerStream)Header¶added inv1.69.0

func (s *ServerStream) Header() (metadata.MD,error)

Header returns the header metadata of the stream. It returns the out headerafter t.WriteHeader is called. It does not block and must not be calleduntil after WriteHeader.

func (*ServerStream)HeaderWireLength¶added inv1.69.0

func (s *ServerStream) HeaderWireLength()int

HeaderWireLength returns the size of the headers of the stream as receivedfrom the wire.

func (*ServerStream)Read¶added inv1.69.0

func (s *ServerStream) Read(nint) (mem.BufferSlice,error)

Read reads an n byte message from the input stream.

func (*ServerStream)RecvCompress¶added inv1.69.0

func (s *ServerStream) RecvCompress()string

RecvCompress returns the compression algorithm applied to the inboundmessage. It is empty string if there is no compression applied.

func (*ServerStream)SendCompress¶added inv1.69.0

func (s *ServerStream) SendCompress()string

SendCompress returns the send compressor name.

func (*ServerStream)SendHeader¶added inv1.69.0

func (s *ServerStream) SendHeader(mdmetadata.MD)error

SendHeader sends the header metadata for the given stream.

func (*ServerStream)SetContext¶added inv1.69.0

func (s *ServerStream) SetContext(ctxcontext.Context)

SetContext sets the context of the stream. This will be deleted once thestats handler callouts all move to gRPC layer.

func (*ServerStream)SetHeader¶added inv1.69.0

func (s *ServerStream) SetHeader(mdmetadata.MD)error

SetHeader sets the header metadata. This can be called multiple times.This should not be called in parallel to other data writes.

func (*ServerStream)SetSendCompress¶added inv1.69.0

func (s *ServerStream) SetSendCompress(namestring)error

SetSendCompress sets the compression algorithm to the stream.

func (*ServerStream)SetTrailer¶added inv1.69.0

func (s *ServerStream) SetTrailer(mdmetadata.MD)error

SetTrailer sets the trailer metadata which will be sent with the RPC statusby the server. This can be called multiple times.This should not be called parallel to other data writes.

func (*ServerStream)Write¶added inv1.69.0

func (s *ServerStream) Write(hdr []byte, datamem.BufferSlice, opts *WriteOptions)error

Write writes the hdr and data bytes to the output stream.

func (*ServerStream)WriteStatus¶added inv1.69.0

func (s *ServerStream) WriteStatus(st *status.Status)error

WriteStatus sends the status of a stream to the client. WriteStatus isthe final call made on a stream and always occurs.

type ServerTransport interface {// HandleStreams receives incoming streams using the given handler.HandleStreams(context.Context, func(*ServerStream))// Close tears down the transport. Once it is called, the transport// should not be accessed any more. All the pending streams and their// handlers will be terminated asynchronously.Close(errerror)// Peer returns the peer of the server transport.Peer() *peer.Peer// Drain notifies the client this ServerTransport stops accepting new RPCs.Drain(debugDatastring)}

funcNewServerHandlerTransport¶

func NewServerHandlerTransport(whttp.ResponseWriter, r *http.Request, statsstats.Handler, bufferPoolmem.BufferPool) (ServerTransport,error)

NewServerHandlerTransport returns a ServerTransport handling gRPC frominside an http.Handler, or writes an HTTP error to w and returns an error.It requires that the http Server supports HTTP/2.

funcNewServerTransport¶

func NewServerTransport(connnet.Conn, config *ServerConfig) (_ServerTransport, errerror)

NewServerTransport creates a http2 transport with conn and configurationoptions from config.

It returns a non-nil transport and a nil error on success. On failure, itreturns a nil transport and a non-nil error. For a special case where theunderlying conn gets closed before the client preface could be read, itreturns a nil transport and a nil error.

type Stream struct {// contains filtered or unexported fields}

func (*Stream)Context¶

func (s *Stream) Context()context.Context

Context returns the context of the stream.

func (*Stream)GoString¶

func (s *Stream) GoString()string

GoString is implemented by Stream so context.String() won'trace when printing %#v.

func (*Stream)Method¶

func (s *Stream) Method()string

Method returns the method for the stream.

func (*Stream)ReadMessageHeader¶added inv1.69.0

func (s *Stream) ReadMessageHeader(header []byte) (errerror)

ReadMessageHeader reads data into the provided header slice from the stream.It first checks if there was an error during a previous read operation andreturns it if present. It then requests a read operation for the length ofthe header. It continues to read from the stream until the entire headerslice is filled or an error occurs. If an `io.EOF` error is encountered withpartially read data, it is converted to `io.ErrUnexpectedEOF` to indicate anunexpected end of the stream. The method returns any error encountered duringthe read process or nil if the header was successfully read.

func (*Stream)Trailer¶

func (s *Stream) Trailer()metadata.MD

Trailer returns the cached trailer metadata. Note that if it is not calledafter the entire stream is done, it could return an empty MD.It can be safely read only after stream has ended that is either reador write have returned io.EOF.

type WriteOptions struct {// Last indicates whether this write is the last piece for// this stream.Lastbool}