package
0.10.3
Repository: https://github.com/cloudwego/kitex.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
Package connpool provide short connection and long connection pool.
Package remotecli for remote client.
No description provided by the author
No description provided by the author
Package transmeta .

# Functions

FillSendMsgFromRecvMsg is used to fill the transport information to the message to be sent.
GetPayloadCodec gets desired payload codec from message.
No description provided by the author
No description provided by the author
NewByteBufferIO wraps ByBuffer to io.ReadWriter.
NewCustomMetaHandler is used to initialize a customMetaHandler with only the needed functions Usage example: serverOption := server.WithMetaHandler(remote.NewCustomMetaHandler(remote.WithOnReadStream( func(ctx context.Context) (context.Context, error) { return context.WithValue(ctx, "key", "value"), nil }, ))).
NewDefaultDialer is used to create a default dialer.
NewMessage creates a new Message using the given info.
NewMessageWithNewer creates a new Message and set data later.
NewProfilerMetaHandler creates profiler MetaHandler.
NewProtocolInfo creates a new ProtocolInfo using the given tp and ct.
NewReaderBuffer is used to create a defaultByteBuffer using the given buf.
NewReaderWriterBuffer is used to create a defaultByteBuffer using the given size.
NewTransError to build TransError with typeID and rawErr.
NewTransErrorWithMsg to build TransError with typeID and errMsg.
NewTransPipeline is used to create a new TransPipeline.
NewWriterBuffer is used to create a defaultByteBuffer using the given size.
PutPayloadCode puts the desired payload codec to message.
RecycleMessage is used to recycle message.
No description provided by the author
No description provided by the author
WithOnConnectStream is used to set the onConnectStream function of customMetaHandler.
WithOnReadStream is used to set the onReadStream function of customMetaHandler.
WithReadMeta is used to set the readMeta function of customMetaHandler.
WithWriteMeta is used to set the writeMeta function of customMetaHandler.

# Constants

corresponding with thrift TApplicationException, cannot change it.
Mask bits.
Mask bits.
MessageTypes.
RPC role.
MessageTypes.
Compression types.
MessageTypes.
corresponding with thrift TApplicationException, cannot change it.
0-4 corresponding to thrift.TMessageType.
corresponding with thrift TApplicationException, cannot change it.
corresponding with thrift TApplicationException, cannot change it.
corresponding with thrift TApplicationException, cannot change it.
MeshHeader use in message.Tag to check MeshHeader.
corresponding with thrift TApplicationException, cannot change it.
Compression types.
corresponding with thrift TApplicationException, cannot change it.
Oneway means there's no need to wait for the response.
corresponding with thrift TApplicationException, cannot change it.
ReadFailed .
MessageTypes.
RPC role.
MessageTypes.
corresponding with thrift TApplicationException, cannot change it.
corresponding with thrift TApplicationException, cannot change it.
kitex's own type id from number 20.
corresponding with thrift TApplicationException, cannot change it.
corresponding with thrift TApplicationException, cannot change it.

# Structs

ByteBufferIO wrap ByteBuffer to implement io.ReadWriter.
ClientOption is used to init the remote client.
ConnOption contains configurations for connection pool.
Option is used to pack the inbound and outbound handlers.
ProtocolInfo is used to indicate the transport protocol and payload codec information.
ServerOption contains option that is used to init the remote server.
SynthesizedDialer is used to synthesize a DialFunc to implement a Dialer.
TransError is the error that can be transmitted, it corresponds to TApplicationException in Thrift.
TransPipeline contains TransHandlers.

# Interfaces

BoundHandler is used to abstract the bound handler.
ByteBuffer is the core abstraction of buffer in Kitex.
ByteBufferFactory is used to create ByteBuffer.
ClientTransHandler is just TransHandler.
ClientTransHandlerFactory to new TransHandler for client.
Codec is the abstraction of the codec layer of Kitex.
ConnPool is used to get connections.
ConnPoolReporter is used to enable reporter.
Dialer is used to dial and get a connection.
DuplexBoundHandler can process both inbound and outbound connections.
FrameWrite is to write header and data buffer separately to avoid memory copy.
GracefulShutdown supports closing connections in a graceful manner.
InboundHandler is used to process read event.
InvokeHandleFuncSetter is used to set invoke handle func.
IsActive is used to check if the connection is active.
LongConnPool supports Clean connections to a desired address.
Message is the core abstraction for Kitex message.
MetaDecoder is an abstraction of the decode layer that has meta and payload stage.
MetaEncoder is an abstraction of the encode layer that has meta and payload stage.
MetaHandler reads or writes metadata through certain protocol.
NocopyWrite is to write []byte without copying, and splits the original buffer.
OutboundHandler is used to process write event.
PayloadCodec is used to marshal and unmarshal payload.
RawConn is used to get the raw connection.
ServerTransHandler have some new functions.
ServerTransHandlerFactory to new TransHandler for server.
ServiceSearcher is used to search the service info by service name and method name, strict equals to true means the service name must match the registered service name.
StreamingMetaHandler reads or writes metadata through streaming header(http2 header).
TransHandler is similar to the handler role in netty Transport can be refactored to support pipeline, and then is able to support other extensions at conn level.
TransInfo contains transport information.
TransReadWriter .
TransServer is the abstraction for remote server.
TransServerFactory is used to create TransServer instances.
TypeId is used to assert Error with has 'TypeId() int32' like TApplicationException.
TypeId is used to assert Error with has 'TypeID() int32'.

# Type aliases

CompressType tells compression type for a message.
CustomMetaHandlerOption is the option for initializing customMetaHandler.
No description provided by the author
MessageType indicates the type of message.
RPCRole is to distinguished client or server.
No description provided by the author