echo

Documentation

Index

• type EchoServer
  • func NewEchoServer() *EchoServer
  • func (ec *EchoServer) Broadcast(channel string, message *types.Data) error
  • func (ec *EchoServer) Find(id string) *socket.Socket
  • func (ec *EchoServer) Init(io *socket.Server) (err error)
  • func (ec *EchoServer) Listen()
  • func (ec *EchoServer) OnClientEvent(_socket *socket.Socket)
  • func (ec *EchoServer) OnConnect()
  • func (ec *EchoServer) OnDisconnecting(_socket *socket.Socket)
  • func (ec *EchoServer) OnSubscribe(_socket *socket.Socket)
  • func (ec *EchoServer) OnUnsubscribe(_socket *socket.Socket)
  • func (ec *EchoServer) Run(_options *options.Config) error
  • func (ec *EchoServer) Startup()
  • func (ec *EchoServer) Stop()
  • func (ec *EchoServer) ToAll(channel string, message *types.Data) error
  • func (ec *EchoServer) ToOthers(_socket *socket.Socket, channel string, message *types.Data) error

Types

type EchoServer

type EchoServer struct {

	// Default server options.
	DefaultOptions *options.Config
	// contains filtered or unexported fields
}

func NewEchoServer

func NewEchoServer() *EchoServer

Create a new instance.

func (*EchoServer) Broadcast

func (ec *EchoServer) Broadcast(channel string, message *types.Data) error

Broadcast events to channels from subscribers.

func (*EchoServer) Find

func (ec *EchoServer) Find(id string) *socket.Socket

Return a channel by its socket id.

func (*EchoServer) Init

func (ec *EchoServer) Init(io *socket.Server) (err error)

Initialize the class

func (*EchoServer) Listen

func (ec *EchoServer) Listen()

Listen for incoming event from subscibers.

func (*EchoServer) OnClientEvent

func (ec *EchoServer) OnClientEvent(_socket *socket.Socket)

On client events.

func (*EchoServer) OnConnect

func (ec *EchoServer) OnConnect()

On server connection.

func (*EchoServer) OnDisconnecting

func (ec *EchoServer) OnDisconnecting(_socket *socket.Socket)

On socket disconnecting.

func (*EchoServer) OnSubscribe

func (ec *EchoServer) OnSubscribe(_socket *socket.Socket)

On subscribe to a channel.

func (*EchoServer) OnUnsubscribe

func (ec *EchoServer) OnUnsubscribe(_socket *socket.Socket)

On unsubscribe from a channel.

func (*EchoServer) Run

func (ec *EchoServer) Run(_options *options.Config) error

Start the Echo Server.

func (*EchoServer) Startup

func (ec *EchoServer) Startup()

Text shown at Startup.

func (*EchoServer) Stop

func (ec *EchoServer) Stop()

Stop the echo server.

func (*EchoServer) ToAll

func (ec *EchoServer) ToAll(channel string, message *types.Data) error

Broadcast to all members on channel.

func (*EchoServer) ToOthers

func (ec *EchoServer) ToOthers(_socket *socket.Socket, channel string, message *types.Data) error

Broadcast to others on channel.