Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

wolfsocket

package module

Go to main page

Versions in this module

v0

v0.1.15

Oct 11, 2023

v0.1.14

Sep 21, 2023

Changes in this version

+ var ErrUninitialized = errors.New("uninitialized")

+ var OnChat = "_OnChat"

+ var OnPartyCreate = "_OnPartyCreate"

+ var OnPartyInvite = "_OnPartyInvite"

+ var OnPartyJoin = "_OnPartyJoin"

+ var OnPartyJoined = "_OnPartyJoined"

+ var OnPartyLeave = "_OnPartyLeave"

+ var OnPartyLeft = "_OnPartyLeft"

+ var OnPartyReceiveMessageInvite = "_OnPartyReceiveMessageInvite"

+ var OnPartyReplyInvitation = "_OnPartyReplyInvitation"

+ var OnPartySomebodyJoined = "_OnPartySomebodyJoined"

+ var OnPartySomebodyLeft = "_OnPartySomebodyLeft"

+ var OnReceiveMsgChat = "_ReceiveMsgChat"

+ func Publish(channel string, msgs ...protos.ServerMessage) error

+ func SetForcedJoin(isForced bool)

+ type BaseParty struct

+ ID string

+ func NewParty(partyID string) *BaseParty

+ func (p *BaseParty) Broadcast(eventName string, body []byte, opts ...options.BroadcastOption)

+ func (p *BaseParty) Create(nsConn *NSConn) error

+ func (p *BaseParty) GetChannel() string

+ func (p *BaseParty) Join(nsConn *NSConn, playerInfo []byte) error

+ func (p *BaseParty) Leave() error

+ func (p *BaseParty) NSConn() *NSConn

+ func (p *BaseParty) PartyID() string

+ func (p *BaseParty) PartyInfo() []byte

+ func (p *BaseParty) SetPartyID(partyID string)

+ func (p *BaseParty) String() string

+ func (p *BaseParty) Subscribe()

+ func (p *BaseParty) Unsubscribe()

+ type BaseRoomChat struct

+ ID string

+ func NewRoomChat(roomID string, channel RoomChannel, conn *NSConn) *BaseRoomChat

+ func (rc *BaseRoomChat) Channel() RoomChannel

+ func (rc *BaseRoomChat) Chat(messageData any)

+ func (rc *BaseRoomChat) Conn() *NSConn

+ func (rc *BaseRoomChat) RoomChatID() string

+ func (rc *BaseRoomChat) String() string

+ func (rc *BaseRoomChat) Subscribe()

+ func (rc *BaseRoomChat) Unsubscribe()

type Conn

+ func (c *Conn) Del(key string)

type Events

+ func (e Events) FireEvent(c *NSConn, msg Message) error

+ type Friends struct

type Message

+ IsServer bool

+ Token string

type NSConn

+ Party Party

+ func (ns *NSConn) AskPartyCreate(msg Message) error

+ func (ns *NSConn) AskPartyInvite(msg Message)

+ func (ns *NSConn) AskPartyJoin(msg Message) error

+ func (ns *NSConn) AskPartyLeave(msg Message) error

+ func (ns *NSConn) AskRemote(ctx context.Context, event string, body []byte) (Message, error)

+ func (ns *NSConn) FireEvent(msg Message) error

+ func (ns *NSConn) ForceLeaveParty() error

+ func (ns *NSConn) Get(key string, value interface{}) (err error)

+ func (ns *NSConn) ID() string

+ func (ns *NSConn) IsInParty() bool

+ func (ns *NSConn) JoinRoomChat(room RoomChat) error

+ func (ns *NSConn) LeaveRoomChat(roomChannel RoomChannel) error

+ func (ns *NSConn) Namespace() string

+ func (ns *NSConn) ReplyLeft()

+ func (ns *NSConn) RoomChat(roomChannel RoomChannel) RoomChat

+ func (ns *NSConn) Set(key string, value interface{})

+ func (ns *NSConn) Write(eventName string, body []byte)

+ func (nsConn *NSConn) AddFriends(friendIDs ...string)

+ func (nsConn *NSConn) AskServer(ctx context.Context, channel string, msg protos.ServerMessage, ...) (*protos.ReplyMessage, error)

+ func (nsConn *NSConn) CheckIsFriend(friendsID string) bool

+ func (nsConn *NSConn) ForceDisconnect()

+ func (nsConn *NSConn) Notify(msg protos.ServerMessage, opts ...options.BroadcastOption) error

+ func (nsConn *NSConn) RemoveFriends(friendIDs ...string)

+ func (nsConn *NSConn) SBroadcast(channel string, msg protos.ServerMessage, opts ...options.BroadcastOption) error

+ func (nsConn *NSConn) Subscribe(channel string)

+ func (nsConn *NSConn) SubscribeNotify(friendIDs ...string)

+ func (nsConn *NSConn) UnSubscribeNotify()

+ func (nsConn *NSConn) Unsubscribe(channel string)

+ type Party interface

+ Broadcast func(eventName string, body []byte, opts ...options.BroadcastOption)

+ Create func(nsConn *NSConn) error

+ GetChannel func() string

+ Join func(nsConn *NSConn, playerInfo []byte) error

+ Leave func() error

+ NSConn func() *NSConn

+ PartyID func() string

+ PartyInfo func() []byte

+ SetPartyID func(partyID string)

+ Subscribe func()

+ Unsubscribe func()

+ type RoomChannel uint32

+ var PartyChatRoom RoomChannel = 1

+ type RoomChat interface

+ Channel func() RoomChannel

+ Chat func(any)

+ Conn func() *NSConn

+ RoomChatID func() string

+ Subscribe func()

+ Unsubscribe func()

type Server

+ HeaderReader func(conn *Conn, h http.Header)

+ func (s *Server) AskServer(ctx context.Context, channel string, msg protos.ServerMessage) (*protos.ReplyMessage, error)

+ func (s *Server) FindAndFire(fn func(*Conn), serverConnID []string)

+ func (s *Server) SBroadcast(channel string, msgs ...protos.ServerMessage) error

type StackExchange

+ AskServer func(ctx context.Context, channel string, msg protos.ServerMessage) (*protos.ReplyMessage, error)

v0.1.13

Apr 11, 2023

Changes in this version

+ const BinaryMessage

+ const TextMessage

+ const URLParamAsHeaderPrefix

+ var DefaultMarshaler = json.Marshal

+ var DefaultUnmarshaler = json.Unmarshal

+ var ErrBadNamespace = errors.New("bad namespace")

+ var ErrBadRoom = errors.New("bad room")

+ var ErrInvalidPayload = errors.New("invalid payload")

+ var ErrWrite = errors.New("write closed")

+ var EventPrefixMatcher = func(prefix string) EventMatcherFunc

+ var EventTrimPrefixMatcher = func(prefixToTrim string) EventMatcherFunc

+ var OnAnyEvent = "_OnAnyEvent"

+ var OnNamespaceConnect = "_OnNamespaceConnect"

+ var OnNamespaceConnected = "_OnNamespaceConnected"

+ var OnNamespaceDisconnect = "_OnNamespaceDisconnect"

+ var OnNativeMessage = "_OnNativeMessage"

+ var OnRoomJoin = "_OnRoomJoin"

+ var OnRoomJoined = "_OnRoomJoined"

+ var OnRoomLeave = "_OnRoomLeave"

+ var OnRoomLeft = "_OnRoomLeft"

+ func DebugEach(mapOrSlice interface{}, onDebugVisitor interface{})

+ func Debugf(format string, args ...interface{})

+ func EnableDebug(printer interface{})

+ func Exclude(connID string) fmt.Stringer

+ func IsCloseError(err error) bool

+ func IsDisconnectError(err error) bool

+ func IsSystemEvent(event string) bool

+ func IsTimeoutError(err error) bool

+ func IsTryingToReconnect(err error) (ok bool)

+ func Marshal(v interface{}) []byte

+ func RegisterKnownError(err error)

+ func Reply(body []byte) error

+ type Client struct

+ ID string

+ NotifyClose <-chan struct{}

+ func Dial(ctx context.Context, dial Dialer, url string, connHandler ConnHandler) (*Client, error)

+ func (c *Client) Close()

+ func (c *Client) Connect(ctx context.Context, namespace string) (*NSConn, error)

+ func (c *Client) WaitServerConnect(ctx context.Context, namespace string) (*NSConn, error)

+ type CloseError struct

+ Code int

+ func (err CloseError) Error() string

+ type Conn struct

+ ReconnectTries int

+ func (c *Conn) Ask(ctx context.Context, msg Message) (Message, error)

+ func (c *Conn) Close()

+ func (c *Conn) Connect(ctx context.Context, namespace string) (*NSConn, error)

+ func (c *Conn) Decrement(key string) int

+ func (c *Conn) DeserializeMessage(msgTyp MessageType, payload []byte) Message

+ func (c *Conn) DisconnectAll(ctx context.Context) error

+ func (c *Conn) Get(key string) interface{}

+ func (c *Conn) GetConnectedNamespaceNames() []string

+ func (c *Conn) GetServerConnID() string

+ func (c *Conn) HandlePayload(msgTyp MessageType, payload []byte) error

+ func (c *Conn) ID() string

+ func (c *Conn) Increment(key string) int

+ func (c *Conn) Is(connID string) bool

+ func (c *Conn) IsClient() bool

+ func (c *Conn) IsClosed() bool

+ func (c *Conn) Namespace(namespace string) *NSConn

+ func (c *Conn) Server() *Server

+ func (c *Conn) Set(key string, value interface{})

+ func (c *Conn) Socket() Socket

+ func (c *Conn) String() string

+ func (c *Conn) WaitConnect(ctx context.Context, namespace string) (ns *NSConn, err error)

+ func (c *Conn) WasReconnected() bool

+ func (c *Conn) Write(msg Message) bool

+ type ConnHandler interface

+ GetNamespaces func() Namespaces

+ func JoinConnHandlers(connHandlers ...ConnHandler) ConnHandler

+ type Dialer func(ctx context.Context, url string) (Socket, error)

+ type EventMatcherFunc = func(methodName string) (string, bool)

+ type Events map[string]MessageHandlerFunc

+ func (e Events) GetNamespaces() Namespaces

+ func (e Events) On(eventName string, msgHandler MessageHandlerFunc)

+ type IDGenerator func(w http.ResponseWriter, r *http.Request) string

+ var DefaultIDGenerator IDGenerator = func(http.ResponseWriter, *http.Request) string { ... }

+ type Message struct

+ Body []byte

+ Err error

+ Event string

+ FromExplicit string

+ FromStackExchange bool

+ IsForced bool

+ IsLocal bool

+ IsNative bool

+ Namespace string

+ Room string

+ SetBinary bool

+ To string

+ func DeserializeMessage(msgTyp MessageType, b []byte, ...) Message

+ func (m *Message) ClearWait() bool

+ func (m *Message) IsWait(isClientConn bool) bool

+ func (m *Message) Unmarshal(outPtr interface{}) error

+ func (m Message) Serialize() []byte

+ type MessageHandlerFunc func(*NSConn, Message) error

+ type MessageObjectMarshaler interface

+ Marshal func() ([]byte, error)

+ type MessageObjectUnmarshaler interface

+ Unmarshal func(body []byte) error

+ type MessageType uint8

+ type NSConn struct

+ Conn *Conn

+ func (ns *NSConn) Ask(ctx context.Context, event string, body []byte) (Message, error)

+ func (ns *NSConn) Disconnect(ctx context.Context) error

+ func (ns *NSConn) Emit(event string, body []byte) bool

+ func (ns *NSConn) EmitBinary(event string, body []byte) bool

+ func (ns *NSConn) JoinRoom(ctx context.Context, roomName string) (*Room, error)

+ func (ns *NSConn) LeaveAll(ctx context.Context) error

+ func (ns *NSConn) Room(roomName string) *Room

+ func (ns *NSConn) Rooms() []*Room

+ func (ns *NSConn) String() string

+ type Namespaces map[string]Events

+ func (nss Namespaces) GetNamespaces() Namespaces

+ func (nss Namespaces) On(namespace, eventName string, msgHandler MessageHandlerFunc) Events

+ type Room struct

+ NSConn *NSConn

+ Name string

+ func (r *Room) Emit(event string, body []byte) bool

+ func (r *Room) Leave(ctx context.Context) error

+ func (r *Room) String() string

+ type Server struct

+ FireDisconnectAlways bool

+ IDGenerator IDGenerator

+ OnConnect func(c *Conn) error

+ OnDisconnect func(c *Conn)

+ OnUpgradeError func(err error)

+ StackExchange StackExchange

+ SyncBroadcaster bool

+ func New(upgrader Upgrader, connHandler ConnHandler) *Server

+ func (s *Server) Ask(ctx context.Context, msg Message) (Message, error)

+ func (s *Server) Broadcast(exceptSender fmt.Stringer, msgs ...Message)

+ func (s *Server) Close()

+ func (s *Server) Do(fn func(*Conn), async bool)

+ func (s *Server) GetConnections() map[string]*Conn

+ func (s *Server) GetConnectionsByNamespace(namespace string) map[string]*NSConn

+ func (s *Server) GetTotalConnections() uint64

+ func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (s *Server) Upgrade(w http.ResponseWriter, r *http.Request, socketWrapper func(Socket) Socket, ...) (*Conn, error)

+ func (s *Server) UseStackExchange(exc StackExchange) error

+ type Socket interface

+ NetConn func() net.Conn

+ ReadData func(timeout time.Duration) (body []byte, typ MessageType, err error)

+ Request func() *http.Request

+ WriteBinary func(body []byte, timeout time.Duration) error

+ WriteText func(body []byte, timeout time.Duration) error

+ type StackExchange interface

+ Ask func(ctx context.Context, msg Message, token string) (Message, error)

+ NotifyAsk func(msg Message, token string) error

+ OnConnect func(c *Conn) error

+ OnDisconnect func(c *Conn)

+ Publish func(msgs []Message) bool

+ Subscribe func(c *Conn, namespace string)

+ Unsubscribe func(c *Conn, namespace string)

+ type StackExchangeInitializer interface

+ Init func(Namespaces) error

+ type Struct struct

+ func NewStruct(ptr interface{}) *Struct

+ func (s *Struct) Events() Events

+ func (s *Struct) GetNamespaces() Namespaces

+ func (s *Struct) SetEventMatcher(matcher EventMatcherFunc) *Struct

+ func (s *Struct) SetInjector(fn StructInjector) *Struct

+ func (s *Struct) SetNamespace(namespace string) *Struct

+ func (s *Struct) SetTimeouts(read, write time.Duration) *Struct

+ type StructInjector func(structType reflect.Type, nsConn *NSConn) (structValue reflect.Value)

+ type Upgrader func(w http.ResponseWriter, r *http.Request) (Socket, error)

+ type WithTimeout struct

+ Events Events

+ Namespaces Namespaces

+ ReadTimeout time.Duration

+ WriteTimeout time.Duration

+ func (t WithTimeout) GetNamespaces() Namespaces