stdio

Documentation

Index

• type Config
• type Gateway
  • func New(in io.ReadCloser, out *log.Logger, conf *Config) *Gateway
  • func (o *Gateway) Ban(uid string) error
  • func (o *Gateway) Channel() *gateway.Channel
  • func (o *Gateway) ChannelUsers() []gateway.User
  • func (o *Gateway) Kick(uid string) error
  • func (o *Gateway) Ping(uid string) (time.Duration, error)
  • func (o *Gateway) Relay(ev *network.Event, from gateway.Gateway) error
  • func (o *Gateway) Run(ctx context.Context) error
  • func (o *Gateway) Say(s string) error
  • func (o *Gateway) SayPrivate(uid string, s string) error
  • func (o *Gateway) SetUserAccess(uid string, a gateway.AccessLevel) (*gateway.AccessLevel, error)
  • func (o *Gateway) Unban(uid string) error
  • func (o *Gateway) User(uid string) (*gateway.User, error)
  • func (o *Gateway) Users() map[string]gateway.AccessLevel

Types

type Config

type Config struct {
	gateway.Config
	Read      bool
	Access    gateway.AccessLevel
	AvatarURL string
}

Config stores the gateway configuration

type Gateway

type Gateway struct {
	gateway.Common
	network.EventEmitter

	*Config
	In  io.ReadCloser
	Out *log.Logger
}

Gateway relays between stdin/stdout

func New

func New(in io.ReadCloser, out *log.Logger, conf *Config) *Gateway

New initializes a new Gateway struct

func (*Gateway) Ban

func (o *Gateway) Ban(uid string) error

Ban user from channel

func (*Gateway) Channel

func (o *Gateway) Channel() *gateway.Channel

Channel residing in

func (*Gateway) ChannelUsers

func (o *Gateway) ChannelUsers() []gateway.User

ChannelUsers online

func (*Gateway) Kick

func (o *Gateway) Kick(uid string) error

Kick user from channel

func (*Gateway) Ping

func (o *Gateway) Ping(uid string) (time.Duration, error)

Ping user to calculate RTT in milliseconds

func (*Gateway) Relay

func (o *Gateway) Relay(ev *network.Event, from gateway.Gateway) error

Relay dumps the event content to stdout

func (*Gateway) Run

func (o *Gateway) Run(ctx context.Context) error

Run reads packets and emits an event for each received packet

func (*Gateway) Say

func (o *Gateway) Say(s string) error

Say sends a chat message

func (*Gateway) SayPrivate

func (o *Gateway) SayPrivate(uid string, s string) error

SayPrivate sends a private chat message to uid

func (*Gateway) SetUserAccess

func (o *Gateway) SetUserAccess(uid string, a gateway.AccessLevel) (*gateway.AccessLevel, error)

SetUserAccess overrides accesslevel for a specific user

func (*Gateway) Unban

func (o *Gateway) Unban(uid string) error

Unban user from channel

func (*Gateway) User

func (o *Gateway) User(uid string) (*gateway.User, error)

User by ID

func (*Gateway) Users

func (o *Gateway) Users() map[string]gateway.AccessLevel

Users with non-default access level