bootc

Documentation

Index

• Constants
• Variables
• func Serv(opts ...Option) listener.IConnector
• type ByteOrder
• type Option
  • func WithByteOrderLittleEndian() Option
  • func WithInitializer(initializer channel.ChannelInitializer) Option
  • func WithKeyLengthInclude() Option
  • func WithLogger(l logger.Logger) Option
  • func WithMsgType(msgType int) Option
  • func WithPacketBytesCount(packetBytesCount int32) Option
  • func WithReadLimit(readLimit int32) Option
  • func WithReadTimeOut(readTimeOut int32) Option
  • func WithSkipPacketBytesCount() Option
  • func WithWriteTimeOut(writeTimeOut int32) Option
• type Options

Constants

const (
	KeyConnType string = "KeyConnType" // 连接类型
	KeyIP       string = "KeyIP"       // 连接IP
	KeyPort     string = "KeyPort"     // 连接端口
)

Variables

var Default = &Options{
	MsgType:              websocket.BinaryMessage,
	ByteOrder:            byteOrderBigEndian,
	ReadTimeOut:          30,
	WriteTimeOut:         30,
	ReadLimit:            256,
	PacketBytesCount:     4,
	LengthInclude:        false,
	SkipPacketBytesCount: false,
	channelParams:        make(map[string]interface{}),
}

Functions

func Serv

func Serv(opts ...Option) listener.IConnector

Types

type ByteOrder

type ByteOrder int8

type Option

type Option func(*Options)

func WithByteOrderLittleEndian

func WithByteOrderLittleEndian() Option

使用小端字节序

func WithInitializer

func WithInitializer(initializer channel.ChannelInitializer) Option

func WithKeyLengthInclude

func WithKeyLengthInclude() Option

包长度是否包含自己的长度

func WithLogger

func WithLogger(l logger.Logger) Option

func WithMsgType

func WithMsgType(msgType int) Option

func WithPacketBytesCount

func WithPacketBytesCount(packetBytesCount int32) Option

消息长度占用字节数

func WithReadLimit

func WithReadLimit(readLimit int32) Option

连接读取消息长度限制

func WithReadTimeOut

func WithReadTimeOut(readTimeOut int32) Option

连接读取消息超时时间

func WithSkipPacketBytesCount

func WithSkipPacketBytesCount() Option

跳过包长度

func WithWriteTimeOut

func WithWriteTimeOut(writeTimeOut int32) Option

连接写入消息超时时间

type Options

type Options struct {
	Initializer channel.ChannelInitializer
	Logger      logger.Logger

	MsgType              int
	ByteOrder            ByteOrder // 字节序
	ReadTimeOut          int32     // 连接读取消息超时时间
	WriteTimeOut         int32     // 连接写入消息超时时间
	ReadLimit            int32     // 连接读取消息长度限制
	PacketBytesCount     int32     // 消息长度占用字节数
	LengthInclude        bool      // 包长度是否包含自己的长度
	SkipPacketBytesCount bool      // 跳过包长度
	// contains filtered or unexported fields
}

Options contains some configurations for current node