proto

package
v0.0.0-...-055e899 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 16, 2023 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	MessageType_name = map[int32]string{
		0: "INFO",
		1: "LOGIN",
		2: "LOGOUT",
		3: "GENERATE_RANDOM_NICKNAME",
	}
	MessageType_value = map[string]int32{
		"INFO":                     0,
		"LOGIN":                    1,
		"LOGOUT":                   2,
		"GENERATE_RANDOM_NICKNAME": 3,
	}
)

Enum value maps for MessageType.

Functions

This section is empty.

Types

type Codec

type Codec struct {
	proto.MarshalOptions
	proto.UnmarshalOptions
}

Codec serializes and deserializes data between protocol message and underlying network package data.

func NewCodec

func NewCodec() *Codec

func (*Codec) Decode

func (c *Codec) Decode(r io.Reader) (*Message, error)

func (*Codec) Encode

func (c *Codec) Encode(msg *Message, w io.Writer) error

type GenerateRandomNicknameRequest

type GenerateRandomNicknameRequest struct {
	Sex     int32 `protobuf:"varint,1,opt,name=sex,proto3" json:"sex,omitempty"`         // Sex
	Culture int32 `protobuf:"varint,2,opt,name=culture,proto3" json:"culture,omitempty"` // Culture
	// contains filtered or unexported fields
}

func (*GenerateRandomNicknameRequest) Descriptor deprecated

func (*GenerateRandomNicknameRequest) Descriptor() ([]byte, []int)

Deprecated: Use GenerateRandomNicknameRequest.ProtoReflect.Descriptor instead.

func (*GenerateRandomNicknameRequest) GetCulture

func (x *GenerateRandomNicknameRequest) GetCulture() int32

func (*GenerateRandomNicknameRequest) GetSex

func (*GenerateRandomNicknameRequest) ProtoMessage

func (*GenerateRandomNicknameRequest) ProtoMessage()

func (*GenerateRandomNicknameRequest) ProtoReflect

func (*GenerateRandomNicknameRequest) Reset

func (x *GenerateRandomNicknameRequest) Reset()

func (*GenerateRandomNicknameRequest) String

type GenerateRandomNicknameResponse

type GenerateRandomNicknameResponse struct {
	Nickname string `protobuf:"bytes,1,opt,name=nickname,proto3" json:"nickname,omitempty"` // Nickname
	// contains filtered or unexported fields
}

func (*GenerateRandomNicknameResponse) Descriptor deprecated

func (*GenerateRandomNicknameResponse) Descriptor() ([]byte, []int)

Deprecated: Use GenerateRandomNicknameResponse.ProtoReflect.Descriptor instead.

func (*GenerateRandomNicknameResponse) GetNickname

func (x *GenerateRandomNicknameResponse) GetNickname() string

func (*GenerateRandomNicknameResponse) ProtoMessage

func (*GenerateRandomNicknameResponse) ProtoMessage()

func (*GenerateRandomNicknameResponse) ProtoReflect

func (*GenerateRandomNicknameResponse) Reset

func (x *GenerateRandomNicknameResponse) Reset()

func (*GenerateRandomNicknameResponse) String

type InfoRequest

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

func (*InfoRequest) Descriptor deprecated

func (*InfoRequest) Descriptor() ([]byte, []int)

Deprecated: Use InfoRequest.ProtoReflect.Descriptor instead.

func (*InfoRequest) ProtoMessage

func (*InfoRequest) ProtoMessage()

func (*InfoRequest) ProtoReflect

func (x *InfoRequest) ProtoReflect() protoreflect.Message

func (*InfoRequest) Reset

func (x *InfoRequest) Reset()

func (*InfoRequest) String

func (x *InfoRequest) String() string

type InfoResponse

type InfoResponse struct {
	ServerName       string            `protobuf:"bytes,1,opt,name=server_name,json=serverName,proto3" json:"server_name,omitempty"`                    // server name
	Uptime           string            `protobuf:"bytes,2,opt,name=uptime,proto3" json:"uptime,omitempty"`                                              // server uptime
	OnlinePlayers    int32             `protobuf:"varint,3,opt,name=online_players,json=onlinePlayers,proto3" json:"online_players,omitempty"`          // number of online players
	TotalConnections int32             `protobuf:"varint,4,opt,name=total_connections,json=totalConnections,proto3" json:"total_connections,omitempty"` // total number of network connections
	Metrics          map[string]string ``                                                                                                               // metrics status as key-value pairs
	/* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*InfoResponse) Descriptor deprecated

func (*InfoResponse) Descriptor() ([]byte, []int)

Deprecated: Use InfoResponse.ProtoReflect.Descriptor instead.

func (*InfoResponse) GetMetrics

func (x *InfoResponse) GetMetrics() map[string]string

func (*InfoResponse) GetOnlinePlayers

func (x *InfoResponse) GetOnlinePlayers() int32

func (*InfoResponse) GetServerName

func (x *InfoResponse) GetServerName() string

func (*InfoResponse) GetTotalConnections

func (x *InfoResponse) GetTotalConnections() int32

func (*InfoResponse) GetUptime

func (x *InfoResponse) GetUptime() string

func (*InfoResponse) ProtoMessage

func (*InfoResponse) ProtoMessage()

func (*InfoResponse) ProtoReflect

func (x *InfoResponse) ProtoReflect() protoreflect.Message

func (*InfoResponse) Reset

func (x *InfoResponse) Reset()

func (*InfoResponse) String

func (x *InfoResponse) String() string

type LoginRequest

type LoginRequest struct {
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	// contains filtered or unexported fields
}

func (*LoginRequest) Descriptor deprecated

func (*LoginRequest) Descriptor() ([]byte, []int)

Deprecated: Use LoginRequest.ProtoReflect.Descriptor instead.

func (*LoginRequest) GetPassword

func (x *LoginRequest) GetPassword() string

func (*LoginRequest) GetUsername

func (x *LoginRequest) GetUsername() string

func (*LoginRequest) ProtoMessage

func (*LoginRequest) ProtoMessage()

func (*LoginRequest) ProtoReflect

func (x *LoginRequest) ProtoReflect() protoreflect.Message

func (*LoginRequest) Reset

func (x *LoginRequest) Reset()

func (*LoginRequest) String

func (x *LoginRequest) String() string

type LoginResponse

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

func (*LoginResponse) Descriptor deprecated

func (*LoginResponse) Descriptor() ([]byte, []int)

Deprecated: Use LoginResponse.ProtoReflect.Descriptor instead.

func (*LoginResponse) ProtoMessage

func (*LoginResponse) ProtoMessage()

func (*LoginResponse) ProtoReflect

func (x *LoginResponse) ProtoReflect() protoreflect.Message

func (*LoginResponse) Reset

func (x *LoginResponse) Reset()

func (*LoginResponse) String

func (x *LoginResponse) String() string

type LogoutRequest

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

func (*LogoutRequest) Descriptor deprecated

func (*LogoutRequest) Descriptor() ([]byte, []int)

Deprecated: Use LogoutRequest.ProtoReflect.Descriptor instead.

func (*LogoutRequest) ProtoMessage

func (*LogoutRequest) ProtoMessage()

func (*LogoutRequest) ProtoReflect

func (x *LogoutRequest) ProtoReflect() protoreflect.Message

func (*LogoutRequest) Reset

func (x *LogoutRequest) Reset()

func (*LogoutRequest) String

func (x *LogoutRequest) String() string

type LogoutResponse

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

func (*LogoutResponse) Descriptor deprecated

func (*LogoutResponse) Descriptor() ([]byte, []int)

Deprecated: Use LogoutResponse.ProtoReflect.Descriptor instead.

func (*LogoutResponse) ProtoMessage

func (*LogoutResponse) ProtoMessage()

func (*LogoutResponse) ProtoReflect

func (x *LogoutResponse) ProtoReflect() protoreflect.Message

func (*LogoutResponse) Reset

func (x *LogoutResponse) Reset()

func (*LogoutResponse) String

func (x *LogoutResponse) String() string

type Message

type Message struct {
	Type MessageType `protobuf:"varint,1,opt,name=type,proto3,enum=main.MessageType" json:"type,omitempty"`
	// Types that are assignable to Body:
	//
	//	*Message_Request
	//	*Message_Response
	Body isMessage_Body `protobuf_oneof:"body"`
	// contains filtered or unexported fields
}

Message for encapsulating protocol message

func NewRequestMessage

func NewRequestMessage(msg proto.Message) (*Message, error)

func NewResponseMessage

func NewResponseMessage(msg proto.Message) (*Message, error)

func (*Message) Descriptor deprecated

func (*Message) Descriptor() ([]byte, []int)

Deprecated: Use Message.ProtoReflect.Descriptor instead.

func (*Message) GetBody

func (m *Message) GetBody() isMessage_Body

func (*Message) GetRequest

func (x *Message) GetRequest() *Request

func (*Message) GetResponse

func (x *Message) GetResponse() *Response

func (*Message) GetType

func (x *Message) GetType() MessageType

func (*Message) ProtoMessage

func (*Message) ProtoMessage()

func (*Message) ProtoReflect

func (x *Message) ProtoReflect() protoreflect.Message

func (*Message) Reset

func (x *Message) Reset()

func (*Message) String

func (x *Message) String() string

type MessageType

type MessageType int32

The message type enum

const (
	MessageType_INFO                     MessageType = 0 // INFO command
	MessageType_LOGIN                    MessageType = 1 // LOGIN command
	MessageType_LOGOUT                   MessageType = 2 // LOGOUT command
	MessageType_GENERATE_RANDOM_NICKNAME MessageType = 3 // GENERATE_RANDOM_NICKNAME command
)

func (MessageType) Descriptor

func (MessageType) Enum

func (x MessageType) Enum() *MessageType

func (MessageType) EnumDescriptor deprecated

func (MessageType) EnumDescriptor() ([]byte, []int)

Deprecated: Use MessageType.Descriptor instead.

func (MessageType) Number

func (x MessageType) Number() protoreflect.EnumNumber

func (MessageType) String

func (x MessageType) String() string

func (MessageType) Type

type Message_Request

type Message_Request struct {
	Request *Request `protobuf:"bytes,2,opt,name=request,proto3,oneof"`
}

type Message_Response

type Message_Response struct {
	Response *Response `protobuf:"bytes,3,opt,name=response,proto3,oneof"`
}

type Request

type Request struct {

	// Types that are assignable to Body:
	//
	//	*Request_Info
	//	*Request_Login
	//	*Request_Logout
	//	*Request_GenerateRandomNickname
	Body isRequest_Body `protobuf_oneof:"body"`
	// contains filtered or unexported fields
}

Message for encapsulating different request types

func (*Request) Descriptor deprecated

func (*Request) Descriptor() ([]byte, []int)

Deprecated: Use Request.ProtoReflect.Descriptor instead.

func (*Request) GetBody

func (m *Request) GetBody() isRequest_Body

func (*Request) GetGenerateRandomNickname

func (x *Request) GetGenerateRandomNickname() *GenerateRandomNicknameRequest

func (*Request) GetInfo

func (x *Request) GetInfo() *InfoRequest

func (*Request) GetLogin

func (x *Request) GetLogin() *LoginRequest

func (*Request) GetLogout

func (x *Request) GetLogout() *LogoutRequest

func (*Request) ProtoMessage

func (*Request) ProtoMessage()

func (*Request) ProtoReflect

func (x *Request) ProtoReflect() protoreflect.Message

func (*Request) Reset

func (x *Request) Reset()

func (*Request) String

func (x *Request) String() string

type Request_GenerateRandomNickname

type Request_GenerateRandomNickname struct {
	GenerateRandomNickname *GenerateRandomNicknameRequest `protobuf:"bytes,4,opt,name=generate_random_nickname,json=generateRandomNickname,proto3,oneof"`
}

type Request_Info

type Request_Info struct {
	Info *InfoRequest `protobuf:"bytes,1,opt,name=info,proto3,oneof"`
}

type Request_Login

type Request_Login struct {
	Login *LoginRequest `protobuf:"bytes,2,opt,name=login,proto3,oneof"`
}

type Request_Logout

type Request_Logout struct {
	Logout *LogoutRequest `protobuf:"bytes,3,opt,name=logout,proto3,oneof"`
}

type Response

type Response struct {

	// Types that are assignable to Body:
	//
	//	*Response_Status
	//	*Response_Info
	//	*Response_Login
	//	*Response_Logout
	//	*Response_GenerateRandomNickname
	Body isResponse_Body `protobuf_oneof:"body"`
	// contains filtered or unexported fields
}

Message for encapsulating different response types

func (*Response) Descriptor deprecated

func (*Response) Descriptor() ([]byte, []int)

Deprecated: Use Response.ProtoReflect.Descriptor instead.

func (*Response) GetBody

func (m *Response) GetBody() isResponse_Body

func (*Response) GetGenerateRandomNickname

func (x *Response) GetGenerateRandomNickname() *GenerateRandomNicknameResponse

func (*Response) GetInfo

func (x *Response) GetInfo() *InfoResponse

func (*Response) GetLogin

func (x *Response) GetLogin() *LoginResponse

func (*Response) GetLogout

func (x *Response) GetLogout() *LogoutResponse

func (*Response) GetStatus

func (x *Response) GetStatus() *Status

func (*Response) ProtoMessage

func (*Response) ProtoMessage()

func (*Response) ProtoReflect

func (x *Response) ProtoReflect() protoreflect.Message

func (*Response) Reset

func (x *Response) Reset()

func (*Response) String

func (x *Response) String() string

type Response_GenerateRandomNickname

type Response_GenerateRandomNickname struct {
	GenerateRandomNickname *GenerateRandomNicknameResponse `protobuf:"bytes,5,opt,name=generate_random_nickname,json=generateRandomNickname,proto3,oneof"`
}

type Response_Info

type Response_Info struct {
	Info *InfoResponse `protobuf:"bytes,2,opt,name=info,proto3,oneof"`
}

type Response_Login

type Response_Login struct {
	Login *LoginResponse `protobuf:"bytes,3,opt,name=login,proto3,oneof"`
}

type Response_Logout

type Response_Logout struct {
	Logout *LogoutResponse `protobuf:"bytes,4,opt,name=logout,proto3,oneof"`
}

type Response_Status

type Response_Status struct {
	Status *Status `protobuf:"bytes,1,opt,name=status,proto3,oneof"`
}

type Status

type Status struct {
	Code    int32  `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`      // Status code
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"` // Descriptive message
	// contains filtered or unexported fields
}

Message for conveying response status information

func (*Status) Descriptor deprecated

func (*Status) Descriptor() ([]byte, []int)

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) GetCode

func (x *Status) GetCode() int32

func (*Status) GetMessage

func (x *Status) GetMessage() string

func (*Status) ProtoMessage

func (*Status) ProtoMessage()

func (*Status) ProtoReflect

func (x *Status) ProtoReflect() protoreflect.Message

func (*Status) Reset

func (x *Status) Reset()

func (*Status) String

func (x *Status) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL