rtapi

Documentation

Index

• Variables
• type Envelope
  • func (*Envelope) Descriptor() ([]byte, []int)
  • func (x *Envelope) GetCid() string
  • func (x *Envelope) GetError() *Error
  • func (m *Envelope) GetMessage() isEnvelope_Message
  • func (x *Envelope) GetPing() *Ping
  • func (x *Envelope) GetPong() *Pong
  • func (x *Envelope) GetRpc() *api.Rpc
  • func (*Envelope) ProtoMessage()
  • func (x *Envelope) ProtoReflect() protoreflect.Message
  • func (x *Envelope) Reset()
  • func (x *Envelope) String() string
• type Envelope_Error
• type Envelope_Ping
• type Envelope_Pong
• type Envelope_Rpc
• type Error
  • func (*Error) Descriptor() ([]byte, []int)
  • func (x *Error) GetCode() int32
  • func (x *Error) GetContext() map[string]string
  • func (x *Error) GetMessage() string
  • func (*Error) ProtoMessage()
  • func (x *Error) ProtoReflect() protoreflect.Message
  • func (x *Error) Reset()
  • func (x *Error) String() string
• type Error_Code
  • func (Error_Code) Descriptor() protoreflect.EnumDescriptor
  • func (x Error_Code) Enum() *Error_Code
  • func (Error_Code) EnumDescriptor() ([]byte, []int)
  • func (x Error_Code) Number() protoreflect.EnumNumber
  • func (x Error_Code) String() string
  • func (Error_Code) Type() protoreflect.EnumType
• type Ping
  • func (*Ping) Descriptor() ([]byte, []int)
  • func (*Ping) ProtoMessage()
  • func (x *Ping) ProtoReflect() protoreflect.Message
  • func (x *Ping) Reset()
  • func (x *Ping) String() string
• type Pong
  • func (*Pong) Descriptor() ([]byte, []int)
  • func (*Pong) ProtoMessage()
  • func (x *Pong) ProtoReflect() protoreflect.Message
  • func (x *Pong) Reset()
  • func (x *Pong) String() string

Variables

var (
	Error_Code_name = map[int32]string{
		0: "RUNTIME_EXCEPTION",
		1: "UNRECOGNIZED_PAYLOAD",
		2: "MISSING_PAYLOAD",
		3: "BAD_INPUT",
		4: "RUNTIME_FUNCTION_NOT_FOUND",
		5: "RUNTIME_FUNCTION_EXCEPTION",
	}
	Error_Code_value = map[string]int32{
		"RUNTIME_EXCEPTION":          0,
		"UNRECOGNIZED_PAYLOAD":       1,
		"MISSING_PAYLOAD":            2,
		"BAD_INPUT":                  3,
		"RUNTIME_FUNCTION_NOT_FOUND": 4,
		"RUNTIME_FUNCTION_EXCEPTION": 5,
	}
)

Enum value maps for Error_Code.

var File_realtime_proto protoreflect.FileDescriptor

Types

type Envelope

type Envelope struct {
	Cid string `protobuf:"bytes,1,opt,name=cid,proto3" json:"cid,omitempty"`
	// Types that are assignable to Message:
	//	*Envelope_Error
	//	*Envelope_Rpc
	//	*Envelope_Ping
	//	*Envelope_Pong
	Message isEnvelope_Message `protobuf_oneof:"message"`
	// contains filtered or unexported fields
}

An envelope for a realtime message.

func (*Envelope) Descriptor

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

Deprecated: Use Envelope.ProtoReflect.Descriptor instead.

func (*Envelope) GetCid

func (x *Envelope) GetCid() string

func (*Envelope) GetError

func (x *Envelope) GetError() *Error

func (*Envelope) GetMessage

func (m *Envelope) GetMessage() isEnvelope_Message

func (*Envelope) GetPing

func (x *Envelope) GetPing() *Ping

func (*Envelope) GetPong

func (x *Envelope) GetPong() *Pong

func (*Envelope) GetRpc

func (x *Envelope) GetRpc() *api.Rpc

func (*Envelope) ProtoMessage

func (*Envelope) ProtoMessage()

func (*Envelope) ProtoReflect

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

func (*Envelope) Reset

func (x *Envelope) Reset()

func (*Envelope) String

func (x *Envelope) String() string

type Envelope_Error

type Envelope_Error struct {
	// Describes an error which occurred on the server.
	Error *Error `protobuf:"bytes,11,opt,name=error,proto3,oneof"`
}

type Envelope_Ping

type Envelope_Ping struct {
	// Application-level heartbeat and connection check.
	Ping *Ping `protobuf:"bytes,32,opt,name=ping,proto3,oneof"`
}

type Envelope_Pong

type Envelope_Pong struct {
	// Application-level heartbeat and connection check response.
	Pong *Pong `protobuf:"bytes,33,opt,name=pong,proto3,oneof"`
}

type Envelope_Rpc

type Envelope_Rpc struct {
	// RPC call or response.
	Rpc *api.Rpc `protobuf:"bytes,24,opt,name=rpc,proto3,oneof"`
}

type Error

type Error struct {

	// The error code which should be one of "Error.Code" enums.
	Code int32 `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	// A message in English to help developers debug the response.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// Additional error details which may be different for each response.
	Context map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

A logical error which may occur on the server.

func (*Error) Descriptor

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

Deprecated: Use Error.ProtoReflect.Descriptor instead.

func (*Error) GetCode

func (x *Error) GetCode() int32

func (*Error) GetContext

func (x *Error) GetContext() map[string]string

func (*Error) GetMessage

func (x *Error) GetMessage() string

func (*Error) ProtoMessage

func (*Error) ProtoMessage()

func (*Error) ProtoReflect

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

func (*Error) Reset

func (x *Error) Reset()

func (*Error) String

func (x *Error) String() string

type Error_Code

type Error_Code int32

The selection of possible error codes.

const (
	// An unexpected result from the server.
	Error_RUNTIME_EXCEPTION Error_Code = 0
	// The server received a message which is not recognised.
	Error_UNRECOGNIZED_PAYLOAD Error_Code = 1
	// A message was expected but contains no content.
	Error_MISSING_PAYLOAD Error_Code = 2
	// Fields in the message have an invalid format.
	Error_BAD_INPUT Error_Code = 3
	// The runtime function does not exist on the server.
	Error_RUNTIME_FUNCTION_NOT_FOUND Error_Code = 4
	// The runtime function executed with an error.
	Error_RUNTIME_FUNCTION_EXCEPTION Error_Code = 5
)

func (Error_Code) Descriptor

func (Error_Code) Descriptor() protoreflect.EnumDescriptor

func (Error_Code) Enum

func (x Error_Code) Enum() *Error_Code

func (Error_Code) EnumDescriptor

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

Deprecated: Use Error_Code.Descriptor instead.

func (Error_Code) Number

func (x Error_Code) Number() protoreflect.EnumNumber

func (Error_Code) String

func (x Error_Code) String() string

func (Error_Code) Type

func (Error_Code) Type() protoreflect.EnumType

type Ping

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

Application-level heartbeat and connection check.

func (*Ping) Descriptor

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

Deprecated: Use Ping.ProtoReflect.Descriptor instead.

func (*Ping) ProtoMessage

func (*Ping) ProtoMessage()

func (*Ping) ProtoReflect

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

func (*Ping) Reset

func (x *Ping) Reset()

func (*Ping) String

func (x *Ping) String() string

type Pong

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

Application-level heartbeat and connection check response.

func (*Pong) Descriptor

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

Deprecated: Use Pong.ProtoReflect.Descriptor instead.

func (*Pong) ProtoMessage

func (*Pong) ProtoMessage()

func (*Pong) ProtoReflect

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

func (*Pong) Reset

func (x *Pong) Reset()

func (*Pong) String

func (x *Pong) String() string