session

package session

import "github.com/Diarkis/diarkis/proto/go/session"

Index

Constants
type Broadcast
type Create
type CreateResponsePayload
type GetProps
type GetSessionInfoBySessionID
type GetSessionInfoBySessionType
type GetSessionInfoResponsePayload
type Invite
type Join
type Kick
type Leave
type MessageTo
type MessageToMessagePayload
type MigratePushPayload

Constants

const BroadcastCmd uint16 = 800

BroadcastCmd represents the command ID of the protocol's command ID.

[NOTE] The value is optional and if cmd is not given in the definition JSON, it will be 0.

const BroadcastVer uint8 = 1

BroadcastVer represents the ver of the protocol's command.

[NOTE] The value is optional and if ver is not given in the definition JSON, it will be 0.

const CreateCmd uint16 = 801

CreateCmd represents the command ID of the protocol's command ID.

[NOTE] The value is optional and if cmd is not given in the definition JSON, it will be 0.

const CreateResponsePayloadCmd uint16 = 0

CreateResponsePayloadCmd represents the command ID of the protocol's command ID.

[NOTE] The value is optional and if cmd is not given in the definition JSON, it will be 0.

const CreateResponsePayloadVer uint8 = 0

CreateResponsePayloadVer represents the ver of the protocol's command.

[NOTE] The value is optional and if ver is not given in the definition JSON, it will be 0.

const CreateVer uint8 = 1

CreateVer represents the ver of the protocol's command.

[NOTE] The value is optional and if ver is not given in the definition JSON, it will be 0.

const GetPropsCmd uint16 = 811

GetPropsCmd represents the command ID of the protocol's command ID.

[NOTE] The value is optional and if cmd is not given in the definition JSON, it will be 0.

const GetPropsVer uint8 = 1

GetPropsVer represents the ver of the protocol's command.

[NOTE] The value is optional and if ver is not given in the definition JSON, it will be 0.

const GetSessionInfoBySessionIDCmd uint16 = 809

GetSessionInfoBySessionIDCmd represents the command ID of the protocol's command ID.

[NOTE] The value is optional and if cmd is not given in the definition JSON, it will be 0.

const GetSessionInfoBySessionIDVer uint8 = 1

GetSessionInfoBySessionIDVer represents the ver of the protocol's command.

[NOTE] The value is optional and if ver is not given in the definition JSON, it will be 0.

const GetSessionInfoBySessionTypeCmd uint16 = 808

GetSessionInfoBySessionTypeCmd represents the command ID of the protocol's command ID.

[NOTE] The value is optional and if cmd is not given in the definition JSON, it will be 0.

const GetSessionInfoBySessionTypeVer uint8 = 1

GetSessionInfoBySessionTypeVer represents the ver of the protocol's command.

[NOTE] The value is optional and if ver is not given in the definition JSON, it will be 0.

const GetSessionInfoResponsePayloadCmd uint16 = 0

GetSessionInfoResponsePayloadCmd represents the command ID of the protocol's command ID.

[NOTE] The value is optional and if cmd is not given in the definition JSON, it will be 0.

const GetSessionInfoResponsePayloadVer uint8 = 0

GetSessionInfoResponsePayloadVer represents the ver of the protocol's command.

[NOTE] The value is optional and if ver is not given in the definition JSON, it will be 0.

const InviteCmd uint16 = 802

InviteCmd represents the command ID of the protocol's command ID.

[NOTE] The value is optional and if cmd is not given in the definition JSON, it will be 0.

const InviteVer uint8 = 1

InviteVer represents the ver of the protocol's command.

[NOTE] The value is optional and if ver is not given in the definition JSON, it will be 0.

const JoinCmd uint16 = 804

JoinCmd represents the command ID of the protocol's command ID.

[NOTE] The value is optional and if cmd is not given in the definition JSON, it will be 0.

const JoinVer uint8 = 1

JoinVer represents the ver of the protocol's command.

[NOTE] The value is optional and if ver is not given in the definition JSON, it will be 0.

const KickCmd uint16 = 806

KickCmd represents the command ID of the protocol's command ID.

[NOTE] The value is optional and if cmd is not given in the definition JSON, it will be 0.

const KickVer uint8 = 1

KickVer represents the ver of the protocol's command.

[NOTE] The value is optional and if ver is not given in the definition JSON, it will be 0.

const LeaveCmd uint16 = 805

LeaveCmd represents the command ID of the protocol's command ID.

[NOTE] The value is optional and if cmd is not given in the definition JSON, it will be 0.

const LeaveVer uint8 = 1

LeaveVer represents the ver of the protocol's command.

[NOTE] The value is optional and if ver is not given in the definition JSON, it will be 0.

const MessageToCmd uint16 = 807

MessageToCmd represents the command ID of the protocol's command ID.

[NOTE] The value is optional and if cmd is not given in the definition JSON, it will be 0.

const MessageToMessagePayloadCmd uint16 = 0

MessageToMessagePayloadCmd represents the command ID of the protocol's command ID.

[NOTE] The value is optional and if cmd is not given in the definition JSON, it will be 0.

const MessageToMessagePayloadVer uint8 = 0

MessageToMessagePayloadVer represents the ver of the protocol's command.

[NOTE] The value is optional and if ver is not given in the definition JSON, it will be 0.

const MessageToVer uint8 = 1

MessageToVer represents the ver of the protocol's command.

[NOTE] The value is optional and if ver is not given in the definition JSON, it will be 0.

const MigratePushPayloadCmd uint16 = 0

MigratePushPayloadCmd represents the command ID of the protocol's command ID.

[NOTE] The value is optional and if cmd is not given in the definition JSON, it will be 0.

const MigratePushPayloadVer uint8 = 0

MigratePushPayloadVer represents the ver of the protocol's command.

[NOTE] The value is optional and if ver is not given in the definition JSON, it will be 0.

Types

type Broadcast

type Broadcast struct {
	// Command version of the protocol
	Ver uint8
	// Command ID of the protocol
	Cmd uint16
	// Message
	Message string
	// Session Type
	SessionType uint8
}

Broadcast represents the command protocol data structure.

func NewBroadcast

func NewBroadcast() *Broadcast

NewBroadcast creates a new instance of Broadcast struct.

func (*Broadcast) GetCmd

func (proto *Broadcast) GetCmd() uint16

func (*Broadcast) GetVer

func (proto *Broadcast) GetVer() uint8

func (*Broadcast) Pack

func (proto *Broadcast) Pack() []byte

Pack encodes Broadcast struct to a byte array to be delivered over the command.

func (*Broadcast) PackedSize

func (proto *Broadcast) PackedSize() int

PackedSize returns the estimated packed size of the struct.

func (*Broadcast) String

func (proto *Broadcast) String() string

func (*Broadcast) Unpack

func (proto *Broadcast) Unpack(bytes []byte) error

Unpack decodes the command payload byte array to Broadcast struct.

type Create

type Create struct {
	// Command version of the protocol
	Ver uint8
	// Command ID of the protocol
	Cmd uint16
	// Maximum number of members in the session
	MaxMembers uint16
	// Session Type
	SessionType uint8
	// TTL of the session when it becomes empty (no members) in seconds.
	Ttl uint16
}

Create represents the command protocol data structure.

func NewCreate

func NewCreate() *Create

NewCreate creates a new instance of Create struct.

func (*Create) GetCmd

func (proto *Create) GetCmd() uint16

func (*Create) GetVer

func (proto *Create) GetVer() uint8

func (*Create) Pack

func (proto *Create) Pack() []byte

Pack encodes Create struct to a byte array to be delivered over the command.

func (*Create) PackedSize

func (proto *Create) PackedSize() int

PackedSize returns the estimated packed size of the struct.

func (*Create) String

func (proto *Create) String() string

func (*Create) Unpack

func (proto *Create) Unpack(bytes []byte) error

Unpack decodes the command payload byte array to Create struct.

type CreateResponsePayload

type CreateResponsePayload struct {
	// Command version of the protocol
	Ver uint8
	// Command ID of the protocol
	Cmd uint16
	// Session ID
	SessionID string
	// Session Type
	SessionType uint8
}

CreateResponsePayload represents the command protocol data structure.

func NewCreateResponsePayload

func NewCreateResponsePayload() *CreateResponsePayload

NewCreateResponsePayload creates a new instance of CreateResponsePayload struct.

func (*CreateResponsePayload) GetCmd

func (proto *CreateResponsePayload) GetCmd() uint16

func (*CreateResponsePayload) GetVer

func (proto *CreateResponsePayload) GetVer() uint8

func (*CreateResponsePayload) Pack

func (proto *CreateResponsePayload) Pack() []byte

Pack encodes CreateResponsePayload struct to a byte array to be delivered over the command.

func (*CreateResponsePayload) PackedSize

func (proto *CreateResponsePayload) PackedSize() int

PackedSize returns the estimated packed size of the struct.

func (*CreateResponsePayload) String

func (proto *CreateResponsePayload) String() string

func (*CreateResponsePayload) Unpack

func (proto *CreateResponsePayload) Unpack(bytes []byte) error

Unpack decodes the command payload byte array to CreateResponsePayload struct.

type GetProps

type GetProps struct {
	// Command version of the protocol
	Ver uint8
	// Command ID of the protocol
	Cmd uint16
	// Session Type
	SessionType uint8
}

GetProps represents the command protocol data structure.

func NewGetProps

func NewGetProps() *GetProps

NewGetProps creates a new instance of GetProps struct.

func (*GetProps) GetCmd

func (proto *GetProps) GetCmd() uint16

func (*GetProps) GetVer

func (proto *GetProps) GetVer() uint8

func (*GetProps) Pack

func (proto *GetProps) Pack() []byte

Pack encodes GetProps struct to a byte array to be delivered over the command.

func (*GetProps) PackedSize

func (proto *GetProps) PackedSize() int

PackedSize returns the estimated packed size of the struct.

func (*GetProps) String

func (proto *GetProps) String() string

func (*GetProps) Unpack

func (proto *GetProps) Unpack(bytes []byte) error

Unpack decodes the command payload byte array to GetProps struct.

type GetSessionInfoBySessionID

type GetSessionInfoBySessionID struct {
	// Command version of the protocol
	Ver uint8
	// Command ID of the protocol
	Cmd uint16
	// Session ID
	SessionID string
}

GetSessionInfoBySessionID represents the command protocol data structure.

func NewGetSessionInfoBySessionID

func NewGetSessionInfoBySessionID() *GetSessionInfoBySessionID

NewGetSessionInfoBySessionID creates a new instance of GetSessionInfoBySessionID struct.

func (*GetSessionInfoBySessionID) GetCmd

func (proto *GetSessionInfoBySessionID) GetCmd() uint16

func (*GetSessionInfoBySessionID) GetVer

func (proto *GetSessionInfoBySessionID) GetVer() uint8

func (*GetSessionInfoBySessionID) Pack

func (proto *GetSessionInfoBySessionID) Pack() []byte

Pack encodes GetSessionInfoBySessionID struct to a byte array to be delivered over the command.

func (*GetSessionInfoBySessionID) PackedSize

func (proto *GetSessionInfoBySessionID) PackedSize() int

PackedSize returns the estimated packed size of the struct.

func (*GetSessionInfoBySessionID) String

func (proto *GetSessionInfoBySessionID) String() string

func (*GetSessionInfoBySessionID) Unpack

func (proto *GetSessionInfoBySessionID) Unpack(bytes []byte) error

Unpack decodes the command payload byte array to GetSessionInfoBySessionID struct.

type GetSessionInfoBySessionType

type GetSessionInfoBySessionType struct {
	// Command version of the protocol
	Ver uint8
	// Command ID of the protocol
	Cmd uint16
	// Session Type
	SessionType uint8
}

GetSessionInfoBySessionType represents the command protocol data structure.

func NewGetSessionInfoBySessionType

func NewGetSessionInfoBySessionType() *GetSessionInfoBySessionType

NewGetSessionInfoBySessionType creates a new instance of GetSessionInfoBySessionType struct.

func (*GetSessionInfoBySessionType) GetCmd

func (proto *GetSessionInfoBySessionType) GetCmd() uint16

func (*GetSessionInfoBySessionType) GetVer

func (proto *GetSessionInfoBySessionType) GetVer() uint8

func (*GetSessionInfoBySessionType) Pack

func (proto *GetSessionInfoBySessionType) Pack() []byte

Pack encodes GetSessionInfoBySessionType struct to a byte array to be delivered over the command.

func (*GetSessionInfoBySessionType) PackedSize

func (proto *GetSessionInfoBySessionType) PackedSize() int

PackedSize returns the estimated packed size of the struct.

func (*GetSessionInfoBySessionType) String

func (proto *GetSessionInfoBySessionType) String() string

func (*GetSessionInfoBySessionType) Unpack

func (proto *GetSessionInfoBySessionType) Unpack(bytes []byte) error

Unpack decodes the command payload byte array to GetSessionInfoBySessionType struct.

type GetSessionInfoResponsePayload

type GetSessionInfoResponsePayload struct {
	// Command version of the protocol
	Ver uint8
	// Command ID of the protocol
	Cmd uint16
	// Current number of members in the session
	CurrentMembers uint16
	// Maximum number of members in the session
	MaxMembers uint16
	// member IDs
	MemberIDs []string
	// owner ID
	OwnerID string
	// Session ID
	SessionID string
	// Session Type
	SessionType uint8
}

GetSessionInfoResponsePayload represents the command protocol data structure.

func NewGetSessionInfoResponsePayload

func NewGetSessionInfoResponsePayload() *GetSessionInfoResponsePayload

NewGetSessionInfoResponsePayload creates a new instance of GetSessionInfoResponsePayload struct.

func (*GetSessionInfoResponsePayload) GetCmd

func (proto *GetSessionInfoResponsePayload) GetCmd() uint16

func (*GetSessionInfoResponsePayload) GetVer

func (proto *GetSessionInfoResponsePayload) GetVer() uint8

func (*GetSessionInfoResponsePayload) Pack

func (proto *GetSessionInfoResponsePayload) Pack() []byte

Pack encodes GetSessionInfoResponsePayload struct to a byte array to be delivered over the command.

func (*GetSessionInfoResponsePayload) PackedSize

func (proto *GetSessionInfoResponsePayload) PackedSize() int

PackedSize returns the estimated packed size of the struct.

func (*GetSessionInfoResponsePayload) String

func (proto *GetSessionInfoResponsePayload) String() string

func (*GetSessionInfoResponsePayload) Unpack

func (proto *GetSessionInfoResponsePayload) Unpack(bytes []byte) error

Unpack decodes the command payload byte array to GetSessionInfoResponsePayload struct.

type Invite

type Invite struct {
	// Command version of the protocol
	Ver uint8
	// Command ID of the protocol
	Cmd uint16
	// Message
	Message string
	// Session Type
	SessionType uint8
	// UIDs to invite
	TargetUIDs []string
}

Invite represents the command protocol data structure.

func NewInvite

func NewInvite() *Invite

NewInvite creates a new instance of Invite struct.

func (*Invite) GetCmd

func (proto *Invite) GetCmd() uint16

func (*Invite) GetVer

func (proto *Invite) GetVer() uint8

func (*Invite) Pack

func (proto *Invite) Pack() []byte

Pack encodes Invite struct to a byte array to be delivered over the command.

func (*Invite) PackedSize

func (proto *Invite) PackedSize() int

PackedSize returns the estimated packed size of the struct.

func (*Invite) String

func (proto *Invite) String() string

func (*Invite) Unpack

func (proto *Invite) Unpack(bytes []byte) error

Unpack decodes the command payload byte array to Invite struct.

type Join

type Join struct {
	// Command version of the protocol
	Ver uint8
	// Command ID of the protocol
	Cmd uint16
	// Session ID
	SessionID string
	// Session Type
	SessionType uint8
}

Join represents the command protocol data structure.

func NewJoin

func NewJoin() *Join

NewJoin creates a new instance of Join struct.

func (*Join) GetCmd

func (proto *Join) GetCmd() uint16

func (*Join) GetVer

func (proto *Join) GetVer() uint8

func (*Join) Pack

func (proto *Join) Pack() []byte

Pack encodes Join struct to a byte array to be delivered over the command.

func (*Join) PackedSize

func (proto *Join) PackedSize() int

PackedSize returns the estimated packed size of the struct.

func (*Join) String

func (proto *Join) String() string

func (*Join) Unpack

func (proto *Join) Unpack(bytes []byte) error

Unpack decodes the command payload byte array to Join struct.

type Kick

type Kick struct {
	// Command version of the protocol
	Ver uint8
	// Command ID of the protocol
	Cmd uint16
	// Session Type
	SessionType uint8
	// UID to kick from session
	TargetUID string
}

Kick represents the command protocol data structure.

func NewKick

func NewKick() *Kick

NewKick creates a new instance of Kick struct.

func (*Kick) GetCmd

func (proto *Kick) GetCmd() uint16

func (*Kick) GetVer

func (proto *Kick) GetVer() uint8

func (*Kick) Pack

func (proto *Kick) Pack() []byte

Pack encodes Kick struct to a byte array to be delivered over the command.

func (*Kick) PackedSize

func (proto *Kick) PackedSize() int

PackedSize returns the estimated packed size of the struct.

func (*Kick) String

func (proto *Kick) String() string

func (*Kick) Unpack

func (proto *Kick) Unpack(bytes []byte) error

Unpack decodes the command payload byte array to Kick struct.

type Leave

type Leave struct {
	// Command version of the protocol
	Ver uint8
	// Command ID of the protocol
	Cmd uint16
	// Session Type
	SessionType uint8
}

Leave represents the command protocol data structure.

func NewLeave

func NewLeave() *Leave

NewLeave creates a new instance of Leave struct.

func (*Leave) GetCmd

func (proto *Leave) GetCmd() uint16

func (*Leave) GetVer

func (proto *Leave) GetVer() uint8

func (*Leave) Pack

func (proto *Leave) Pack() []byte

Pack encodes Leave struct to a byte array to be delivered over the command.

func (*Leave) PackedSize

func (proto *Leave) PackedSize() int

PackedSize returns the estimated packed size of the struct.

func (*Leave) String

func (proto *Leave) String() string

func (*Leave) Unpack

func (proto *Leave) Unpack(bytes []byte) error

Unpack decodes the command payload byte array to Leave struct.

type MessageTo

type MessageTo struct {
	// Command version of the protocol
	Ver uint8
	// Command ID of the protocol
	Cmd uint16
	// Message
	Message string
	// UIDs to receive message
	RecipientUIDs []string
	// Session Type
	SessionType uint8
}

MessageTo represents the command protocol data structure.

func NewMessageTo

func NewMessageTo() *MessageTo

NewMessageTo creates a new instance of MessageTo struct.

func (*MessageTo) GetCmd

func (proto *MessageTo) GetCmd() uint16

func (*MessageTo) GetVer

func (proto *MessageTo) GetVer() uint8

func (*MessageTo) Pack

func (proto *MessageTo) Pack() []byte

Pack encodes MessageTo struct to a byte array to be delivered over the command.

func (*MessageTo) PackedSize

func (proto *MessageTo) PackedSize() int

PackedSize returns the estimated packed size of the struct.

func (*MessageTo) String

func (proto *MessageTo) String() string

func (*MessageTo) Unpack

func (proto *MessageTo) Unpack(bytes []byte) error

Unpack decodes the command payload byte array to MessageTo struct.

type MessageToMessagePayload

type MessageToMessagePayload struct {
	// Command version of the protocol
	Ver uint8
	// Command ID of the protocol
	Cmd uint16
	// Message
	Message string
	// Session Type
	SessionType uint8
}

MessageToMessagePayload represents the command protocol data structure.

func NewMessageToMessagePayload

func NewMessageToMessagePayload() *MessageToMessagePayload

NewMessageToMessagePayload creates a new instance of MessageToMessagePayload struct.

func (*MessageToMessagePayload) GetCmd

func (proto *MessageToMessagePayload) GetCmd() uint16

func (*MessageToMessagePayload) GetVer

func (proto *MessageToMessagePayload) GetVer() uint8

func (*MessageToMessagePayload) Pack

func (proto *MessageToMessagePayload) Pack() []byte

Pack encodes MessageToMessagePayload struct to a byte array to be delivered over the command.

func (*MessageToMessagePayload) PackedSize

func (proto *MessageToMessagePayload) PackedSize() int

PackedSize returns the estimated packed size of the struct.

func (*MessageToMessagePayload) String

func (proto *MessageToMessagePayload) String() string

func (*MessageToMessagePayload) Unpack

func (proto *MessageToMessagePayload) Unpack(bytes []byte) error

Unpack decodes the command payload byte array to MessageToMessagePayload struct.

type MigratePushPayload

type MigratePushPayload struct {
	// Command version of the protocol
	Ver uint8
	// Command ID of the protocol
	Cmd uint16
	// Session ID
	SessionID string
	// Session Type
	SessionType uint8
}

MigratePushPayload represents the command protocol data structure.

func NewMigratePushPayload

func NewMigratePushPayload() *MigratePushPayload

NewMigratePushPayload creates a new instance of MigratePushPayload struct.

func (*MigratePushPayload) GetCmd

func (proto *MigratePushPayload) GetCmd() uint16

func (*MigratePushPayload) GetVer

func (proto *MigratePushPayload) GetVer() uint8

func (*MigratePushPayload) Pack

func (proto *MigratePushPayload) Pack() []byte

Pack encodes MigratePushPayload struct to a byte array to be delivered over the command.

func (*MigratePushPayload) PackedSize

func (proto *MigratePushPayload) PackedSize() int

PackedSize returns the estimated packed size of the struct.

func (*MigratePushPayload) String

func (proto *MigratePushPayload) String() string

func (*MigratePushPayload) Unpack

func (proto *MigratePushPayload) Unpack(bytes []byte) error

Unpack decodes the command payload byte array to MigratePushPayload struct.