session

Documentation

Overview

Package session for knetty

Index

• type CloseCallBackFunc
• type Codec
• type EventListener
• type ExecStatus
• type Session
  • func NewSession(conn connection.Connection) Session
• type WrappedEventTrigger
  • func NewSessionEventTrigger(session *session) *WrappedEventTrigger
  • func (s WrappedEventTrigger) OnConnHup()
  • func (s WrappedEventTrigger) OnConnReadable(buf []byte) int

Types

type CloseCallBackFunc

type CloseCallBackFunc func(Session)

CloseCallBackFunc exec when session stopping

type Codec

type Codec interface {
	// Encode will convert object to binary network data
	Encode(pkg interface{}) ([]byte, error)

	// Decode will convert binary network data into upper-layer protocol objects.
	// The following three conditions are used to distinguish abnormal, half - wrapped, normal and sticky packets.
	// Exceptions: nil,0,err
	// Half-pack: nil,0,nil
	// Normal & Sticky package: pkg,pkgLen,nil
	Decode([]byte) (interface{}, int, error)
}

Codec for session

type EventListener

type EventListener interface {
	// OnConnect runs when the connection initialized
	OnConnect(s Session)
	// OnMessage runs when the session gets a pkg
	OnMessage(s Session, pkg interface{}) ExecStatus
	// OnError runs when the session err
	OnError(s Session, e error)
	// OnClose runs before the session closed
	OnClose(s Session)
}

EventListener listener for session event

type ExecStatus

type ExecStatus int

const (
	Normal ExecStatus = iota
)

type Session

type Session interface {
	// LocalAddr return local address (for example, "192.0.2.1:25", "[2001:db8::1]:80")
	LocalAddr() string
	// RemoteAddr return remote address (for example, "192.0.2.1:25", "[2001:db8::1]:80")
	RemoteAddr() string
	// SetCodec setting yourself codec is necessary, otherwise a panic will occur at runtime
	SetCodec(Codec)
	// SetEventListener setting yourself eventListener is necessary, otherwise a panic will occur at runtime
	SetEventListener(EventListener)
	// WritePkg will encode any type of data as a []byte type using the codec and writes it to the conn buffer.
	// If you want the other end of the network to receive it,
	// call the FlushBuffer API to send all the data from the conn buffer out
	WritePkg(pkg interface{}) (int, error)
	// WriteBuffer will write bytes to conn buffer
	WriteBuffer(bytes []byte) (int, error)
	// FlushBuffer will send conn buffer data to net
	FlushBuffer() error
	//	Run will run this session
	Run() error
	// SetCloseCallBackFunc setting closeBackFunc for session
	SetCloseCallBackFunc(fn CloseCallBackFunc)
	// Info return session info
	Info() string
	// Close will stop session
	Close() error
}

Session client、server session

func NewSession

func NewSession(conn connection.Connection) Session

NewSession create new session.

type WrappedEventTrigger

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

func NewSessionEventTrigger

func NewSessionEventTrigger(session *session) *WrappedEventTrigger

func (WrappedEventTrigger) OnConnHup

func (s WrappedEventTrigger) OnConnHup()

func (WrappedEventTrigger) OnConnReadable

func (s WrappedEventTrigger) OnConnReadable(buf []byte) int