comet

type Auth struct {
	// Usually a JWT is used. Comet.Subscribe extracts user's account information from this token.
	Token                string   `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type BroadcastReq struct {
	// The room identity, default (empty) to do a world broadcast, which means all the clients on
	// this comet instance are published with the event. Otherwise, the broadcast is delivered to
	// the clients within the room.
	Rid string `protobuf:"bytes,1,opt,name=rid,proto3" json:"rid,omitempty"`
	// The server-sent event goes through the downlink to the client.
	// Its content is opaque, which means what is published here reaches client unmodified.
	// Only the concrete business can explain this event.
	Evt                  string   `protobuf:"bytes,2,opt,name=evt,proto3" json:"evt,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type BroadcastRes struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

type CometHandler interface {
	// Subscribe for downlink messages while also sending uplink messages.
	Subscribe(context.Context, Comet_SubscribeStream) error
	// Publish an event to a specific client who is landing on this comet instance.
	// Publish or Broadcast is not reliable innately! The event may not reach the client in
	// case of comet restarts or broken connection. So it is not necessary to retry automatically.
	// Usually you should design a SYNC protocol between client and server to achieve the
	// reliable broadcasting.
	Publish(context.Context, *PublishReq, *PublishRes) error
	// Broadcast an event to all the clients in a specific room on this comet instance.
	Broadcast(context.Context, *BroadcastReq, *BroadcastRes) error
	// Dump all the clients' session on this comet instance. It is a debugging method.
	DumpSession(context.Context, *DumpSessionReq, *DumpSessionRes) error
}

type CometService interface {
	// Subscribe for downlink messages while also sending uplink messages.
	Subscribe(ctx context.Context, opts ...client.CallOption) (Comet_SubscribeService, error)
	// Publish an event to a specific client who is landing on this comet instance.
	// Publish or Broadcast is not reliable innately! The event may not reach the client in
	// case of comet restarts or broken connection. So it is not necessary to retry automatically.
	// Usually you should design a SYNC protocol between client and server to achieve the
	// reliable broadcasting.
	Publish(ctx context.Context, in *PublishReq, opts ...client.CallOption) (*PublishRes, error)
	// Broadcast an event to all the clients in a specific room on this comet instance.
	Broadcast(ctx context.Context, in *BroadcastReq, opts ...client.CallOption) (*BroadcastRes, error)
	// Dump all the clients' session on this comet instance. It is a debugging method.
	DumpSession(ctx context.Context, in *DumpSessionReq, opts ...client.CallOption) (*DumpSessionRes, error)
}

type Comet_SubscribeService interface {
	Context() context.Context
	SendMsg(interface{}) error
	RecvMsg(interface{}) error
	Close() error
	Send(*Uplink) error
	Recv() (*Downlink, error)
}

type Comet_SubscribeStream interface {
	Context() context.Context
	SendMsg(interface{}) error
	RecvMsg(interface{}) error
	Close() error
	Send(*Downlink) error
	Recv() (*Uplink, error)
}

type Downlink struct {
	// type is used to differentiate what this downlink message is
	Type                 Packet      `protobuf:"varint,1,opt,name=type,proto3,enum=comet.Packet" json:"type,omitempty"`
	Hb                   *Heartbeat  `protobuf:"bytes,2,opt,name=hb,proto3" json:"hb,omitempty"`
	Push                 *ServerPush `protobuf:"bytes,3,opt,name=push,proto3" json:"push,omitempty"`
	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
	XXX_unrecognized     []byte      `json:"-"`
	XXX_sizecache        int32       `json:"-"`
}

type DumpSessionReq struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type DumpSessionRes struct {
	// All the sessions in the world in this comet instance
	World []*Session `protobuf:"bytes,1,rep,name=world,proto3" json:"world,omitempty"`
	// All the rooms in this comet instance
	Rooms                []*Room  `protobuf:"bytes,2,rep,name=rooms,proto3" json:"rooms,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type Heartbeat struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type JoinRoom struct {
	// The room identity, default (empty) to quit any room and stay only in the world.
	Rid                  string   `protobuf:"bytes,1,opt,name=rid,proto3" json:"rid,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type Packet int32

type PublishReq struct {
	// The unique user identity.
	// Please note if an end-user has multiple terminals such as a phone, a pad, and a desktop,
	// every terminal should use a unique identity if these devices are treated differently.
	Uid string `protobuf:"bytes,1,opt,name=uid,proto3" json:"uid,omitempty"`
	// The server-sent event goes through the downlink to the client.
	// Its content is opaque, which means what is published here reaches client unmodified.
	// Only the concrete business can explain this event.
	Evt                  string   `protobuf:"bytes,2,opt,name=evt,proto3" json:"evt,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type PublishRes struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type Room struct {
	// The room identity
	Rid string `protobuf:"bytes,1,opt,name=rid,proto3" json:"rid,omitempty"`
	// All the sessions in this room.
	Room                 []*Session `protobuf:"bytes,2,rep,name=room,proto3" json:"room,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

type Server struct {
	Namespace      string   `json:"namespace"`
	Production     bool     `json:"production"`
	LogOutputPaths []string `json:"logging_output_paths"`
}

type ServerPush struct {
	// The server-sent event goes through the downlink to the client.
	// Its content is opaque, which means what is published reaches client unmodified.
	// Only the concrete business can explain this event.
	Evt                  string   `protobuf:"bytes,1,opt,name=evt,proto3" json:"evt,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type Session struct {
	// The unique user identity
	Uid string `protobuf:"bytes,1,opt,name=uid,proto3" json:"uid,omitempty"`
	// The room identity
	Rid string `protobuf:"bytes,2,opt,name=rid,proto3" json:"rid,omitempty"`
	// When is the session created
	Birth                string   `protobuf:"bytes,3,opt,name=birth,proto3" json:"birth,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type Uplink struct {
	// type is used to differentiate what this uplink message is
	Type                 Packet     `protobuf:"varint,1,opt,name=type,proto3,enum=comet.Packet" json:"type,omitempty"`
	Hb                   *Heartbeat `protobuf:"bytes,2,opt,name=hb,proto3" json:"hb,omitempty"`
	Auth                 *Auth      `protobuf:"bytes,3,opt,name=auth,proto3" json:"auth,omitempty"`
	Join                 *JoinRoom  `protobuf:"bytes,4,opt,name=join,proto3" json:"join,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}