bigws

package module

Go to main page

Versions in this module

v0

v0.0.5

Nov 19, 2023

Changes in this version

+ var ErrSkippable = errors.New("skippable error") — linux/amd64

type Conn — darwin/amd64, linux/amd64

+ func (c *Conn) WriteFrameOnlyIoUring(fw *fixedwriter.FixedWriter, payload []byte, fin bool, rsv1 bool, isMask bool, ...) (err error)

type EvOption

+ func WithLogLevel(level slog.Level) EvOption

type MultiEventLoop

+ func (m *MultiEventLoop) GetApiName() string

v0.0.4

Nov 1, 2023

Changes in this version

type EvOption

+ func WithIoUring() EvOption

+ func WithMinBusinessGoNum(num int) EvOption

type MultiEventLoop

+ func (m *MultiEventLoop) GetCurConnNum() int64

+ func (m *MultiEventLoop) GetCurTaskNum() int64

v0.0.3

Oct 21, 2023

v0.0.2

Oct 18, 2023

v0.0.1

Oct 17, 2023

Changes in this version

+ const Binary

+ const Close

+ const Continuation

+ const EPOLLET — linux/amd64

+ const EVENT_EPOLL

+ const EVENT_IOURING

+ const Ping

+ const Pong

+ const Text

+ var ErrClosePayloadTooSmall = errors.New("error:close payload too small")

+ var ErrCloseValue = errors.New("error:close value is wrong")

+ var ErrClosed = errors.New("closed")

+ var ErrConnectionFieldValue = errors.New("The value of the connection field is not 'upgrade'")

+ var ErrEmptyClose = errors.New("error:close value is empty")

+ var ErrFrameOpcode = errors.New("error:since all data frames after the initial data frame must have opcode 0.")

+ var ErrHTTPProtocolNotSupported = errors.New("HTTP protocol not supported")

+ var ErrHostCannotBeEmpty = errors.New("Host cannot be empty")

+ var ErrMaxControlFrameSize = errors.New("error:max control frame size > 125, need <= 125")

+ var ErrNOTBeFragmented = errors.New("error:since control message MUST NOT be fragmented")

+ var ErrNotFoundHijacker = errors.New("not found Hijacker")

+ var ErrOnlyGETSupported = errors.New("error:Only get methods are supported")

+ var ErrOpcode = errors.New("error:wrong opcode")

+ var ErrRsv123 = errors.New("error:rsv1 or rsv2 or rsv3 has a value")

+ var ErrSecWebSocketAccept = errors.New("The value of Sec-WebSocketAaccept field is invalid")

+ var ErrSecWebSocketKey = errors.New("The value of SEC websocket key field is wrong")

+ var ErrSecWebSocketVersion = errors.New("The value of SEC websocket version field is wrong, not 13")

+ var ErrTextNotUTF8 = errors.New("error:text is not utf8 data")

+ var ErrUpgradeFieldValue = errors.New("The value of the upgrade field is not 'websocket'")

+ var ErrWriteClosed = errors.New("write close")

+ var ErrWrongStatusCode = errors.New("Wrong status code")

+ func GetPayloadBytes(n int) (rv *[]byte)

+ func PutPayloadBytes(bytes *[]byte)

+ func StringToBytes(s string) (b []byte)

+ func TemporaryError(err error) bool — linux/amd64

+ func WSADuplicateSocket(handle syscall.Handle, pid uint32, pi *syscall.WSAProtocolInfo) (sockerr error) — windows/amd64

+ func WSASocket(af int32, stype int32, protocol int32, pi *syscall.WSAProtocolInfo, g uint32, ...) (handle syscall.Handle, err error) — windows/amd64

+ type Callback interface

+ OnClose func(*Conn, error)

+ OnMessage func(*Conn, Opcode, []byte)

+ OnOpen func(*Conn)

+ type ClientOption func(*DialOption)

+ func WithClientBindHTTPHeader(h *http.Header) ClientOption

+ func WithClientBufioMultipleTimesPayloadSize(mt float32) ClientOption

+ func WithClientCallback(cb Callback) ClientOption

+ func WithClientCallbackFunc(open OnOpenFunc, m OnMessageFunc, c OnCloseFunc) ClientOption

+ func WithClientCompression() ClientOption

+ func WithClientDecompressAndCompress() ClientOption

+ func WithClientDecompression() ClientOption

+ func WithClientDelayWriteInitBufferSize(n int32) ClientOption

+ func WithClientDialTimeout(t time.Duration) ClientOption

+ func WithClientDisableBufioClearHack() ClientOption

+ func WithClientEnableUTF8Check() ClientOption

+ func WithClientHTTPHeader(h http.Header) ClientOption

+ func WithClientIgnorePong() ClientOption

+ func WithClientMaxDelayWriteDuration(d time.Duration) ClientOption

+ func WithClientMaxDelayWriteNum(n int32) ClientOption

+ func WithClientOnCloseFunc(onClose func(c *Conn, err error)) ClientOption

+ func WithClientOnMessageFunc(cb OnMessageFunc) ClientOption

+ func WithClientReadTimeout(t time.Duration) ClientOption

+ func WithClientReplyPing() ClientOption

+ func WithClientTCPDelay() ClientOption

+ func WithClientTLSConfig(tls *tls.Config) ClientOption

+ func WithClientWindowsMultipleTimesPayloadSize(mt float32) ClientOption

+ type CloseErrMsg struct

+ Code StatusCode

+ Msg string

+ func (c CloseErrMsg) Error() string

+ type Config struct

+ type Conn struct — darwin/amd64, linux/amd64, windows/amd64

+ func Dial(rawUrl string, opts ...ClientOption) (*Conn, error)

+ func DialConf(rawUrl string, conf *DialOption) (*Conn, error)

+ func Upgrade(w http.ResponseWriter, r *http.Request, opts ...ServerOption) (c *Conn, err error)

+ func (c *Conn) Close()

+ func (c *Conn) Write(b []byte) (n int, err error)

+ func (c *Conn) WriteMessage(op Opcode, writeBuf []byte) (err error)

+ func (c *Conn) WriteTimeout(op Opcode, data []byte, t time.Duration) (err error)

+ type ConnOption struct

+ type DefCallback struct

+ func (defcallback *DefCallback) OnClose(_ *Conn, _ error)

+ func (defcallback *DefCallback) OnMessage(_ *Conn, _ Opcode, _ []byte)

+ func (defcallback *DefCallback) OnOpen(_ *Conn)

+ type DialOption struct

+ Header http.Header

+ func ClientOptionToConf(opts ...ClientOption) *DialOption

+ func (d *DialOption) Dial() (c *Conn, err error)

+ type ErrErrno struct — linux/amd64

+ Errno syscall.Errno

+ func (e *ErrErrno) Canceled() bool

+ func (e *ErrErrno) ConnectionReset() bool

+ func (e *ErrErrno) Error() string

+ func (e *ErrErrno) Temporary() bool

+ func (e *ErrErrno) Timeout() bool

+ type EvOption func(e *MultiEventLoop)

+ func WithEventLoops(num int) EvOption

+ func WithMaxEventNum(num int) EvOption

+ type EventLoop struct

+ func CreateEventLoop(setSize int) (e *EventLoop, err error)

+ func (e *EventLoop) Shutdown(ctx context.Context) error

+ func (el *EventLoop) GetApiName() string

+ func (el *EventLoop) Loop()

+ func (el *EventLoop) StartLoop()

+ type IOOperation uint8 — windows/amd64

+ type MultiEventLoop struct

+ func NewMultiEventLoop(opts ...EvOption) (e *MultiEventLoop, err error)

+ func NewMultiEventLoopMust(opts ...EvOption) *MultiEventLoop

+ func (m *MultiEventLoop) Start()

+ type OnCloseFunc func(*Conn, error)

+ func (o OnCloseFunc) OnClose(c *Conn, err error)

+ func (o OnCloseFunc) OnMessage(_ *Conn, _ Opcode, _ []byte)

+ func (o OnCloseFunc) OnOpen(_ *Conn)

+ type OnMessageFunc func(*Conn, Opcode, []byte)

+ func (o OnMessageFunc) OnClose(_ *Conn, _ error)

+ func (o OnMessageFunc) OnMessage(c *Conn, op Opcode, data []byte)

+ func (o OnMessageFunc) OnOpen(_ *Conn)

+ type OnOpenFunc func(*Conn)

+ type Opcode = opcode.Opcode

+ type ServerOption func(*ConnOption)

+ func WithServerBufioMultipleTimesPayloadSize(mt float32) ServerOption

+ func WithServerCallback(cb Callback) ServerOption

+ func WithServerCallbackFunc(open OnOpenFunc, m OnMessageFunc, c OnCloseFunc) ServerOption

+ func WithServerDecompressAndCompress() ServerOption

+ func WithServerDecompression() ServerOption

+ func WithServerDelayWriteInitBufferSize(n int32) ServerOption

+ func WithServerDisableBufioClearHack() ServerOption

+ func WithServerEnableUTF8Check() ServerOption

+ func WithServerIgnorePong() ServerOption

+ func WithServerMaxDelayWriteDuration(d time.Duration) ServerOption

+ func WithServerMaxDelayWriteNum(n int32) ServerOption

+ func WithServerMultiEventLoop(m *MultiEventLoop) ServerOption

+ func WithServerOnCloseFunc(onClose func(c *Conn, err error)) ServerOption

+ func WithServerOnMessageFunc(cb OnMessageFunc) ServerOption

+ func WithServerReadTimeout(t time.Duration) ServerOption

+ func WithServerReplyPing() ServerOption

+ func WithServerSubprotocols(subprotocols []string) ServerOption

+ func WithServerTCPDelay() ServerOption

+ func WithServerWindowsMultipleTimesPayloadSize(mt float32) ServerOption

+ type StatusCode int16

+ const DataCannotAccept

+ const EndpointGoingAway

+ const NoExtensions

+ const NormalClosure

+ const NotConsistentMessageType

+ const ProtocolError

+ const ServerTerminating

+ const TerminatingConnection

+ const TooBigMessage

+ func (s StatusCode) String() string

+ type UpgradeServer struct

+ func NewUpgrade(opts ...ServerOption) *UpgradeServer

+ func (u *UpgradeServer) Upgrade(w http.ResponseWriter, r *http.Request) (c *Conn, err error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL