services

Documentation

Index

• type Connector
• type ConnectorRemote
  • func (c *ConnectorRemote) Descriptor(ctx context.Context, names *pitayaprotos.ProtoNames) (*pitayaprotos.ProtoDescriptors, error)
  • func (c *ConnectorRemote) Docs(ctx context.Context) (*pitayaprotos.Doc, error)
  • func (c *ConnectorRemote) RemoteFunc(ctx context.Context, msg *protos.RPCMsg) (*protos.RPCRes, error)
• type Room
  • func NewRoom() *Room
  • func (r *Room) AfterInit()
  • func (r *Room) Entry(ctx context.Context, msg []byte) (*protos.JoinResponse, error)
  • func (r *Room) Init()
  • func (r *Room) Join(ctx context.Context) (*protos.JoinResponse, error)
  • func (r *Room) Message(ctx context.Context, msg *protos.UserMessage)
  • func (r *Room) MessageRemote(ctx context.Context, msg *protos.UserMessage, b bool, s string) (*protos.UserMessage, error)
  • func (r *Room) SendRPC(ctx context.Context, msg *protos.SendRPCMsg) (*protos.RPCRes, error)

Types

type Connector

type Connector struct {
	component.Base
}

Connector struct

type ConnectorRemote

type ConnectorRemote struct {
	component.Base
}

ConnectorRemote is a remote that will receive rpc's

func (*ConnectorRemote) Descriptor

func (c *ConnectorRemote) Descriptor(ctx context.Context, names *pitayaprotos.ProtoNames) (*pitayaprotos.ProtoDescriptors, error)

func (*ConnectorRemote) Docs

func (c *ConnectorRemote) Docs(ctx context.Context) (*pitayaprotos.Doc, error)

Docs returns documentation

func (*ConnectorRemote) RemoteFunc

func (c *ConnectorRemote) RemoteFunc(ctx context.Context, msg *protos.RPCMsg) (*protos.RPCRes, error)

RemoteFunc is a function that will be called remotely

type Room

type Room struct {
	component.Base

	Stats *protos.Stats
	// contains filtered or unexported fields
}

Room represents a component that contains a bundle of room related handler like Join/Message

func NewRoom

func NewRoom() *Room

NewRoom returns a new room

func (*Room) AfterInit

func (r *Room) AfterInit()

AfterInit component lifetime callback

func (*Room) Entry

func (r *Room) Entry(ctx context.Context, msg []byte) (*protos.JoinResponse, error)

Entry is the entrypoint

func (*Room) Init

func (r *Room) Init()

Init runs on service initialization

func (*Room) Join

func (r *Room) Join(ctx context.Context) (*protos.JoinResponse, error)

Join room

func (*Room) Message

func (r *Room) Message(ctx context.Context, msg *protos.UserMessage)

Message sync last message to all members

func (*Room) MessageRemote

func (r *Room) MessageRemote(ctx context.Context, msg *protos.UserMessage, b bool, s string) (*protos.UserMessage, error)

MessageRemote just echoes the given message

func (*Room) SendRPC

func (r *Room) SendRPC(ctx context.Context, msg *protos.SendRPCMsg) (*protos.RPCRes, error)

SendRPC sends rpc