Categorygithub.com/sllt/booby
modulepackage
0.0.2
Repository: https://github.com/sllt/booby.git
Documentation: pkg.go.dev

# README

Booby

booby is a high performance, easy to use and extensible rpc framework.

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

Append exports default package method.
AppendString exports default package method.
AsyncExecute executes a func.
AsyncResponse returns default AsyncResponse flag.
BatchRecv returns default BatchRecv flag.
BatchSend returns default BatchSend flag.
BeforeRecv registers default handler which will be called before Recv.
BeforeSend registers default handler which will be called before Send.
EnablePool registers handlers for pool operation for Context and Message and Message.Buffer.
Free exports default package method.
Handle registers default method/router handler.
HandleConnected registers default handler which will be called when client connected.
HandleDisconnected registers default handler which will be called when client disconnected.
HandleMalloc registers default buffer maker.
HandleMessageDropped registers default handler which will be called when message dropped.
HandleNotFound registers default "" method/router handler, It will be called when mothod/router is not found.
HandleOverstock registers default handler which will be called when client send queue is overstock.
HandleSessionMiss registers default handler which will be called when async message seq not found.
LogDebugInfo .
Malloc exports default package method.
No description provided by the author
New .
NewClient creates a Client.
NewClientPool creates a ClientPool.
NewClientPoolFromDialers creates a ClientPool by multiple dialers.
NewHandler returns a default Handler implementation.
NewMessage creates a Message.
NewServer creates a booby Server.
ReadTimeout returns client's read timeout.
Realloc exports default package method.
RecvBufferSize returns default client's read buffer size.
SendBufferSize returns default client's read buffer size.
SendQueueSize returns default client's send queue channel capacity.
SetAsyncExecutor sets executor.
SetAsyncResponse sets default AsyncResponse flag.
SetBatchRecv sets default BatchRecv flag.
SetBatchSend sets default BatchSend flag.
SetDebug .
SetHandler sets default Handler.
SetLogTag sets DefaultHandler's log tag.
No description provided by the author
SetReaderWrapper registers default reader wrapper for net.Conn.
SetReadTimeout sets client's read timeout.
SetRecvBufferSize sets default client's read buffer size.
SetSendBufferSize sets default client's read buffer size.
SetSendQueueSize sets default client's send queue channel capacity.
SetWriteTimeout sets client's write timeout.
Use registers default method/router handler middleware.
UseCoder registers default message coding middleware, coder.Encode will be called before message send, coder.Decode will be called after message recv.
WriteTimeout returns client's write timeout.

# Constants

CmdNone is invalid.
CmdNotify the other side should not respond to a request message.
CmdPing .
CmdPong .
CmdRequest the other side should respond to a request message.
CmdResponse the other side should not respond to a request message.
DefaultMaxBodyLen limits Message body length.
HeaderFlagMaskAsync .
HeaderFlagMaskError .
HeaderIndexBodyLenBegin .
HeaderIndexBodyLenEnd .
HeaderIndexCmd .
HeaderIndexFlag .
HeaderIndexMethodLen .
HeaderIndexReserved .
HeaderIndexSeqBegin .
HeaderIndexSeqEnd .
HeadLen represents Message head length.
MaxMethodLen limits Message method length.
TimeForever represents forever time.
TimeZero represents zero time.

# Variables

DefaultAllocator .
DefaultHandler is the default Handler used by booby.
ErrClientInvalidAsyncHandler represents an error of invalid(nil) async handler.
ErrClientInvalidPoolDialers represents an error of empty dialer array.
ErrClientInvalidTimeoutLessThanZero represents an error of less than 0 time parameter.
ErrClientInvalidTimeoutZero represents an error of 0 time parameter.
ErrClientInvalidTimeoutZeroWithNonNilCallback represents an error with 0 time parameter but with non-nil callback.
ErrClientOverstock represents an error of Client's send queue is full.
ErrClientReconnecting represents an error that Client is reconnecting.
ErrClientStopped represents an error that Client is stopped.
ErrClientTimeout represents a timeout error because of timer or context.
ErrContextResponseToNotify represents an error that response to a notify message.
ErrInvalidFlagBitIndex represents an error of invlaid flag bit index.
ErrInvalidRspMessage represents an error of invalid message CMD.
ErrMethodNotFound represents an error of method not found.
ErrTimeout represents an error of timeout.
PingMessage .
PongMessage .

# Structs

BufferPool .
Client represents a booby Client.
ClientPool represents a booby Client Pool.
Context represents a booby Call's context.
Message represents an booby Message.
NativeAllocator definition.
Server represents a booby Server.

# Interfaces

No description provided by the author
Handler defines net message handler interface.
MessageCoder defines Message coding middleware interface.

# Type aliases

AsyncHandlerFunc defines callback of Client.CallAsync.
DialerFunc defines the dialer used by booby Client to connect to the server.
HandlerFunc defines message handler of booby middleware and method/router.
Header defines Message head.