protocol

Documentation

Index

• Constants
• Variables
• func DefaultIDHash(key []byte) hash.Hash
• type Account
• type AlwaysValidStrategy
  • func (this AlwaysValidStrategy) Invalidate()
  • func (this AlwaysValidStrategy) IsValid() bool
• type CommandSwitchAccount
• type ID
  • func NewAlterIDs(primary *ID, alterIDCount uint16) []*ID
  • func NewID(uuid *uuid.UUID) *ID
  • func (this *ID) Bytes() []byte
  • func (v ID) CmdKey() []byte
  • func (this *ID) Equals(another *ID) bool
  • func (this *ID) String() string
  • func (this *ID) UUID() *uuid.UUID
• type IDHash
• type RequestCommand
• type RequestHeader
  • func (this *RequestHeader) Destination() v2net.Destination
• type RequestOption
  • func (this *RequestOption) Clear(option RequestOption)
  • func (this RequestOption) Has(option RequestOption) bool
  • func (this *RequestOption) Set(option RequestOption)
• type ResponseCommand
• type ResponseHeader
• type ResponseOption
  • func (this *ResponseOption) Clear(option ResponseOption)
  • func (this ResponseOption) Has(option ResponseOption) bool
  • func (this *ResponseOption) Set(option ResponseOption)
• type RoundRobinServerPicker
  • func NewRoundRobinServerPicker(serverlist *ServerList) *RoundRobinServerPicker
  • func (this *RoundRobinServerPicker) PickServer() *ServerSpec
• type ServerList
  • func NewServerList() *ServerList
  • func (this *ServerList) AddServer(server *ServerSpec)
  • func (this *ServerList) GetServer(idx uint32) *ServerSpec
  • func (this *ServerList) RemoveServer(idx uint32)
  • func (this *ServerList) Size() uint32
• type ServerPicker
• type ServerSpec
  • func NewServerSpec(dest v2net.Destination, valid ValidationStrategy, users ...*User) *ServerSpec
  • func (this *ServerSpec) AddUser(user *User)
  • func (this *ServerSpec) Destination() v2net.Destination
  • func (this *ServerSpec) HasUser(user *User) bool
  • func (this *ServerSpec) Invalidate()
  • func (this *ServerSpec) IsValid() bool
  • func (this *ServerSpec) PickUser() *User
• type TimeoutValidStrategy
  • func (this *TimeoutValidStrategy) Invalidate()
  • func (this *TimeoutValidStrategy) IsValid() bool
• type Timestamp
  • func NowTime() Timestamp
  • func (this Timestamp) Bytes(b []byte) []byte
• type TimestampGenerator
  • func NewTimestampGenerator(base Timestamp, delta int) TimestampGenerator
• type User
  • func NewUser(level UserLevel, email string) *User
• type UserLevel
• type UserSettings
  • func GetUserSettings(level UserLevel) UserSettings
• type UserValidator
• type ValidationStrategy
  • func AlwaysValid() ValidationStrategy
  • func BeforeTime(t time.Time) ValidationStrategy

Constants

const (
	RequestCommandTCP = RequestCommand(0x01)
	RequestCommandUDP = RequestCommand(0x02)
)

const (
	RequestOptionChunkStream     = RequestOption(0x01)
	RequestOptionConnectionReuse = RequestOption(0x02)
)

const (
	UserLevelAdmin     = UserLevel(255)
	UserLevelUntrusted = UserLevel(0)
)

const (
	IDBytesLen = 16
)

const (
	ResponseOptionConnectionReuse = ResponseOption(1)
)

Variables

var (
	ErrInvalidUser    = errors.New("Invalid user.")
	ErrInvalidVersion = errors.New("Invalid version.")
)

var (
	InvalidID = errors.New("Invalid ID.")
)

Functions

func DefaultIDHash

func DefaultIDHash(key []byte) hash.Hash

Types

type Account

type Account interface {
	Equals(Account) bool
}

type AlwaysValidStrategy

type AlwaysValidStrategy struct{}

func (AlwaysValidStrategy) Invalidate

func (this AlwaysValidStrategy) Invalidate()

func (AlwaysValidStrategy) IsValid

func (this AlwaysValidStrategy) IsValid() bool

type CommandSwitchAccount

type CommandSwitchAccount struct {
	Host     v2net.Address
	Port     v2net.Port
	ID       *uuid.UUID
	AlterIds uint16
	Level    UserLevel
	ValidMin byte
}

type ID

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

The ID of en entity, in the form of an UUID.

func NewAlterIDs

func NewAlterIDs(primary *ID, alterIDCount uint16) []*ID

func NewID

func NewID(uuid *uuid.UUID) *ID

func (*ID) Bytes

func (this *ID) Bytes() []byte

func (ID) CmdKey

func (v ID) CmdKey() []byte

func (*ID) Equals

func (this *ID) Equals(another *ID) bool

func (*ID) String

func (this *ID) String() string

func (*ID) UUID

func (this *ID) UUID() *uuid.UUID

type IDHash

type IDHash func(key []byte) hash.Hash

type RequestCommand

type RequestCommand byte

type RequestHeader

type RequestHeader struct {
	Version byte
	User    *User
	Command RequestCommand
	Option  RequestOption
	Address v2net.Address
	Port    v2net.Port
}

func (*RequestHeader) Destination

func (this *RequestHeader) Destination() v2net.Destination

type RequestOption

type RequestOption byte

func (*RequestOption) Clear

func (this *RequestOption) Clear(option RequestOption)

func (RequestOption) Has

func (this RequestOption) Has(option RequestOption) bool

func (*RequestOption) Set

func (this *RequestOption) Set(option RequestOption)

type ResponseCommand

type ResponseCommand interface{}

type ResponseHeader

type ResponseHeader struct {
	Option  ResponseOption
	Command ResponseCommand
}

type ResponseOption

type ResponseOption byte

func (*ResponseOption) Clear

func (this *ResponseOption) Clear(option ResponseOption)

func (ResponseOption) Has

func (this ResponseOption) Has(option ResponseOption) bool

func (*ResponseOption) Set

func (this *ResponseOption) Set(option ResponseOption)

type RoundRobinServerPicker

type RoundRobinServerPicker struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewRoundRobinServerPicker

func NewRoundRobinServerPicker(serverlist *ServerList) *RoundRobinServerPicker

func (*RoundRobinServerPicker) PickServer

func (this *RoundRobinServerPicker) PickServer() *ServerSpec

type ServerList

type ServerList struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewServerList

func NewServerList() *ServerList

func (*ServerList) AddServer

func (this *ServerList) AddServer(server *ServerSpec)

func (*ServerList) GetServer

func (this *ServerList) GetServer(idx uint32) *ServerSpec

func (*ServerList) RemoveServer

func (this *ServerList) RemoveServer(idx uint32)

@Private

func (*ServerList) Size

func (this *ServerList) Size() uint32

type ServerPicker

type ServerPicker interface {
	PickServer() *ServerSpec
}

type ServerSpec

type ServerSpec struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewServerSpec

func NewServerSpec(dest v2net.Destination, valid ValidationStrategy, users ...*User) *ServerSpec

func (*ServerSpec) AddUser

func (this *ServerSpec) AddUser(user *User)

func (*ServerSpec) Destination

func (this *ServerSpec) Destination() v2net.Destination

func (*ServerSpec) HasUser

func (this *ServerSpec) HasUser(user *User) bool

func (*ServerSpec) Invalidate

func (this *ServerSpec) Invalidate()

func (*ServerSpec) IsValid

func (this *ServerSpec) IsValid() bool

func (*ServerSpec) PickUser

func (this *ServerSpec) PickUser() *User

type TimeoutValidStrategy

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

func (*TimeoutValidStrategy) Invalidate

func (this *TimeoutValidStrategy) Invalidate()

func (*TimeoutValidStrategy) IsValid

func (this *TimeoutValidStrategy) IsValid() bool

type Timestamp

type Timestamp int64

func NowTime

func NowTime() Timestamp

func (Timestamp) Bytes

func (this Timestamp) Bytes(b []byte) []byte

type TimestampGenerator

type TimestampGenerator func() Timestamp

func NewTimestampGenerator

func NewTimestampGenerator(base Timestamp, delta int) TimestampGenerator

type User

type User struct {
	Account Account
	Level   UserLevel
	Email   string
}

func NewUser

func NewUser(level UserLevel, email string) *User

type UserLevel

type UserLevel byte

type UserSettings

type UserSettings struct {
	PayloadReadTimeout int
}

func GetUserSettings

func GetUserSettings(level UserLevel) UserSettings

type UserValidator

type UserValidator interface {
	common.Releasable

	Add(user *User) error
	Get(timeHash []byte) (*User, Timestamp, bool)
}

type ValidationStrategy

type ValidationStrategy interface {
	IsValid() bool
	Invalidate()
}

func AlwaysValid

func AlwaysValid() ValidationStrategy

func BeforeTime

func BeforeTime(t time.Time) ValidationStrategy