session

Documentation

Index

• type Processor
• type Registry
  • func NewRegistry() *Registry
  • func (r *Registry) AddSession(xuid string, session *Session)
  • func (r *Registry) GetSession(xuid string) *Session
  • func (r *Registry) GetSessionByUsername(username string) *Session
  • func (r *Registry) GetSessions() []*Session
  • func (r *Registry) RemoveSession(xuid string)
• type Session
  • func NewSession(clientConn *minecraft.Conn, logger internal.Logger, registry *Registry, ...) *Session
  • func (s *Session) Animation() animation.Animation
  • func (s *Session) Client() *minecraft.Conn
  • func (s *Session) Close()
  • func (s *Session) Disconnect(message string)
  • func (s *Session) Latency() int64
  • func (s *Session) Login() (err error)
  • func (s *Session) Opts() util.Opts
  • func (s *Session) Processor() Processor
  • func (s *Session) Server() *server.Conn
  • func (s *Session) SetAnimation(animation animation.Animation)
  • func (s *Session) SetOpts(opts util.Opts)
  • func (s *Session) SetProcessor(processor Processor)
  • func (s *Session) Transfer(addr string) error
• type Tracker
  • func NewTracker() *Tracker

Types

type Processor

type Processor interface {
	// ProcessServer determines whether the provided packet, originating from the server, should be forwarded to the client.
	// It returns true if the packet should be forwarded, otherwise false.
	ProcessServer(packet packet.Packet) bool
	// ProcessClient determines whether the provided packet, originating from the client, should be forwarded to the server.
	// It returns true if the packet should be forwarded, otherwise false.
	ProcessClient(packet packet.Packet) bool

	// ProcessPreTransfer is called before transferring the client to a different server.
	// It can be used for pre-processing tasks before the client transfer starts.
	// The 'addr' parameter represents the address of the target server.
	// It returns true if the transfer process should proceed, otherwise false.
	ProcessPreTransfer(addr string) bool
	// ProcessPostTransfer is called after transferring the client to a different server.
	// It can be used for post-processing tasks after the client transfer completes.
	// The 'addr' parameter represents the address of the target server.
	// Although this method returns a boolean value, it is not currently used and exists for the sake of completeness.
	ProcessPostTransfer(addr string) bool

	// ProcessDisconnection is called when the client disconnects from the server.
	// It can be used for post-processing tasks after the disconnection occurs.
	// Although this method returns a boolean value, it is not currently used and exists for the sake of completeness.
	ProcessDisconnection() bool
}

Processor is an interface defining methods for handling events such as packet sending/receiving, transfers and disconnection.

type Registry

type Registry struct {
	// contains filtered or unexported fields
}

func NewRegistry

func NewRegistry() *Registry

func (*Registry) AddSession

func (r *Registry) AddSession(xuid string, session *Session)

func (*Registry) GetSession

func (r *Registry) GetSession(xuid string) *Session

func (*Registry) GetSessionByUsername

func (r *Registry) GetSessionByUsername(username string) *Session

func (*Registry) GetSessions

func (r *Registry) GetSessions() []*Session

func (*Registry) RemoveSession

func (r *Registry) RemoveSession(xuid string)

type Session

type Session struct {
	// contains filtered or unexported fields
}

func NewSession

func NewSession(clientConn *minecraft.Conn, logger internal.Logger, registry *Registry, discovery server.Discovery, opts util.Opts, transport transport.Transport) *Session

func (*Session) Animation

func (s *Session) Animation() animation.Animation

func (*Session) Client

func (s *Session) Client() *minecraft.Conn

func (*Session) Close

func (s *Session) Close()

func (*Session) Disconnect

func (s *Session) Disconnect(message string)

func (*Session) Latency

func (s *Session) Latency() int64

func (*Session) Login

func (s *Session) Login() (err error)

func (*Session) Opts

func (s *Session) Opts() util.Opts

func (*Session) Processor

func (s *Session) Processor() Processor

func (*Session) Server

func (s *Session) Server() *server.Conn

func (*Session) SetAnimation

func (s *Session) SetAnimation(animation animation.Animation)

func (*Session) SetOpts

func (s *Session) SetOpts(opts util.Opts)

func (*Session) SetProcessor

func (s *Session) SetProcessor(processor Processor)

func (*Session) Transfer

func (s *Session) Transfer(addr string) error

type Tracker

type Tracker struct {
	// contains filtered or unexported fields
}

func NewTracker

func NewTracker() *Tracker