pbx

package
v0.16.4 Latest Latest
Warning

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

Go to latest
Published: Mar 13, 2020 License: GPL-3.0 Imports: 5 Imported by: 0

README

Protocol Buffer and gRPC definitions

Definitions for Tinode gRPC client and plugins.

Tinode gRPC clients must implement rpc service Node, Tinode plugins Plugin.

Generated Go and Python code is included. For a sample Python implementation of a command line client see tn-cli. For a partial plugin implementation see chatbot.

If you want to make changes, you have to install protobuffers tool chain and gRPC:

$ python -m pip install grpcio grpcio-tools googleapis-common-protos

To generate Go bindings add the following comment to your code and run go generate (your actual path to /pbx may be different):

//go:generate protoc --proto_path=../pbx --go_out=plugins=grpc:../pbx ../pbx/model.proto

To generate Python bindings:

python -m grpc_tools.protoc -I../pbx --python_out=. --grpc_python_out=. ../pbx/model.proto

Documentation

Index

Constants

This section is empty.

Variables

View Source
var AuthLevel_name = map[int32]string{
	0:  "NONE",
	10: "ANON",
	20: "AUTH",
	30: "ROOT",
}
View Source
var AuthLevel_value = map[string]int32{
	"NONE": 0,
	"ANON": 10,
	"AUTH": 20,
	"ROOT": 30,
}
View Source
var ClientDel_What_name = map[int32]string{
	0: "MSG",
	1: "TOPIC",
	2: "SUB",
	3: "USER",
	4: "CRED",
}
View Source
var ClientDel_What_value = map[string]int32{
	"MSG":   0,
	"TOPIC": 1,
	"SUB":   2,
	"USER":  3,
	"CRED":  4,
}
View Source
var Crud_name = map[int32]string{
	0: "CREATE",
	1: "UPDATE",
	2: "DELETE",
}
View Source
var Crud_value = map[string]int32{
	"CREATE": 0,
	"UPDATE": 1,
	"DELETE": 2,
}
View Source
var InfoNote_name = map[int32]string{
	0: "READ",
	1: "RECV",
	2: "KP",
}
View Source
var InfoNote_value = map[string]int32{
	"READ": 0,
	"RECV": 1,
	"KP":   2,
}
View Source
var RespCode_name = map[int32]string{
	0: "CONTINUE",
	1: "DROP",
	2: "RESPOND",
	3: "REPLACE",
}
View Source
var RespCode_value = map[string]int32{
	"CONTINUE": 0,
	"DROP":     1,
	"RESPOND":  2,
	"REPLACE":  3,
}
View Source
var ServerPres_What_name = map[int32]string{
	0:  "ON",
	1:  "OFF",
	3:  "UA",
	4:  "UPD",
	5:  "GONE",
	6:  "ACS",
	7:  "TERM",
	8:  "MSG",
	9:  "READ",
	10: "RECV",
	11: "DEL",
	12: "TAGS",
}
View Source
var ServerPres_What_value = map[string]int32{
	"ON":   0,
	"OFF":  1,
	"UA":   3,
	"UPD":  4,
	"GONE": 5,
	"ACS":  6,
	"TERM": 7,
	"MSG":  8,
	"READ": 9,
	"RECV": 10,
	"DEL":  11,
	"TAGS": 12,
}

Functions

func RegisterNodeServer

func RegisterNodeServer(s *grpc.Server, srv NodeServer)

func RegisterPluginServer

func RegisterPluginServer(s *grpc.Server, srv PluginServer)

Types

type AccessMode

type AccessMode struct {
	// Access mode requested by the user
	Want string `protobuf:"bytes,1,opt,name=want" json:"want,omitempty"`
	// Access mode granted to the user by the admin
	Given                string   `protobuf:"bytes,2,opt,name=given" json:"given,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Actual access mode

func (*AccessMode) Descriptor

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

func (*AccessMode) GetGiven

func (m *AccessMode) GetGiven() string

func (*AccessMode) GetWant

func (m *AccessMode) GetWant() string

func (*AccessMode) ProtoMessage

func (*AccessMode) ProtoMessage()

func (*AccessMode) Reset

func (m *AccessMode) Reset()

func (*AccessMode) String

func (m *AccessMode) String() string

func (*AccessMode) XXX_DiscardUnknown

func (m *AccessMode) XXX_DiscardUnknown()

func (*AccessMode) XXX_Marshal

func (m *AccessMode) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AccessMode) XXX_Merge

func (dst *AccessMode) XXX_Merge(src proto.Message)

func (*AccessMode) XXX_Size

func (m *AccessMode) XXX_Size() int

func (*AccessMode) XXX_Unmarshal

func (m *AccessMode) XXX_Unmarshal(b []byte) error

type AccountEvent

type AccountEvent struct {
	Action     Crud            `protobuf:"varint,1,opt,name=action,enum=pbx.Crud" json:"action,omitempty"`
	UserId     string          `protobuf:"bytes,2,opt,name=user_id,json=userId" json:"user_id,omitempty"`
	DefaultAcs *DefaultAcsMode `protobuf:"bytes,3,opt,name=default_acs,json=defaultAcs" json:"default_acs,omitempty"`
	Public     []byte          `protobuf:"bytes,4,opt,name=public,proto3" json:"public,omitempty"`
	// Indexable tags for user discovery
	Tags                 []string `protobuf:"bytes,8,rep,name=tags" json:"tags,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*AccountEvent) Descriptor

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

func (*AccountEvent) GetAction

func (m *AccountEvent) GetAction() Crud

func (*AccountEvent) GetDefaultAcs

func (m *AccountEvent) GetDefaultAcs() *DefaultAcsMode

func (*AccountEvent) GetPublic

func (m *AccountEvent) GetPublic() []byte

func (*AccountEvent) GetTags

func (m *AccountEvent) GetTags() []string

func (*AccountEvent) GetUserId

func (m *AccountEvent) GetUserId() string

func (*AccountEvent) ProtoMessage

func (*AccountEvent) ProtoMessage()

func (*AccountEvent) Reset

func (m *AccountEvent) Reset()

func (*AccountEvent) String

func (m *AccountEvent) String() string

func (*AccountEvent) XXX_DiscardUnknown

func (m *AccountEvent) XXX_DiscardUnknown()

func (*AccountEvent) XXX_Marshal

func (m *AccountEvent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AccountEvent) XXX_Merge

func (dst *AccountEvent) XXX_Merge(src proto.Message)

func (*AccountEvent) XXX_Size

func (m *AccountEvent) XXX_Size() int

func (*AccountEvent) XXX_Unmarshal

func (m *AccountEvent) XXX_Unmarshal(b []byte) error

type AuthLevel

type AuthLevel int32

Authentication level

const (
	AuthLevel_NONE AuthLevel = 0
	AuthLevel_ANON AuthLevel = 10
	AuthLevel_AUTH AuthLevel = 20
	AuthLevel_ROOT AuthLevel = 30
)

func (AuthLevel) EnumDescriptor

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

func (AuthLevel) String

func (x AuthLevel) String() string

type ClientAcc

type ClientAcc struct {
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// User being created or updated
	UserId string `protobuf:"bytes,2,opt,name=user_id,json=userId" json:"user_id,omitempty"`
	// The initial authentication scheme the account can use
	Scheme string `protobuf:"bytes,3,opt,name=scheme" json:"scheme,omitempty"`
	// Shared secret
	Secret []byte `protobuf:"bytes,4,opt,name=secret,proto3" json:"secret,omitempty"`
	// Authenticate session with the newly created account
	Login bool `protobuf:"varint,5,opt,name=login" json:"login,omitempty"`
	// Indexable tags for user discovery
	Tags []string `protobuf:"bytes,6,rep,name=tags" json:"tags,omitempty"`
	// User initialization data when creating a new user, otherwise ignored
	Desc *SetDesc `protobuf:"bytes,7,opt,name=desc" json:"desc,omitempty"`
	// Credentials for verification.
	Cred []*ClientCred `protobuf:"bytes,8,rep,name=cred" json:"cred,omitempty"`
	// Authentication token used for resetting a password.
	Token []byte `protobuf:"bytes,9,opt,name=token,proto3" json:"token,omitempty"`
	// Account state: normal, suspended
	State                string   `protobuf:"bytes,10,opt,name=state" json:"state,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

User creation message {acc}

func (*ClientAcc) Descriptor

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

func (*ClientAcc) GetCred

func (m *ClientAcc) GetCred() []*ClientCred

func (*ClientAcc) GetDesc

func (m *ClientAcc) GetDesc() *SetDesc

func (*ClientAcc) GetId

func (m *ClientAcc) GetId() string

func (*ClientAcc) GetLogin

func (m *ClientAcc) GetLogin() bool

func (*ClientAcc) GetScheme

func (m *ClientAcc) GetScheme() string

func (*ClientAcc) GetSecret

func (m *ClientAcc) GetSecret() []byte

func (*ClientAcc) GetState

func (m *ClientAcc) GetState() string

func (*ClientAcc) GetTags

func (m *ClientAcc) GetTags() []string

func (*ClientAcc) GetToken

func (m *ClientAcc) GetToken() []byte

func (*ClientAcc) GetUserId

func (m *ClientAcc) GetUserId() string

func (*ClientAcc) ProtoMessage

func (*ClientAcc) ProtoMessage()

func (*ClientAcc) Reset

func (m *ClientAcc) Reset()

func (*ClientAcc) String

func (m *ClientAcc) String() string

func (*ClientAcc) XXX_DiscardUnknown

func (m *ClientAcc) XXX_DiscardUnknown()

func (*ClientAcc) XXX_Marshal

func (m *ClientAcc) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClientAcc) XXX_Merge

func (dst *ClientAcc) XXX_Merge(src proto.Message)

func (*ClientAcc) XXX_Size

func (m *ClientAcc) XXX_Size() int

func (*ClientAcc) XXX_Unmarshal

func (m *ClientAcc) XXX_Unmarshal(b []byte) error

type ClientCred

type ClientCred struct {
	// Credential type, i.e. `email` or `tel`.
	Method string `protobuf:"bytes,1,opt,name=method" json:"method,omitempty"`
	// Value to verify, i.e. `user@example.com` or `+18003287448`
	Value string `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
	// Verification response
	Response string `protobuf:"bytes,3,opt,name=response" json:"response,omitempty"`
	// Request parameters, such as preferences.
	Params               []byte   `protobuf:"bytes,4,opt,name=params,proto3" json:"params,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Credentials such as email or phone number

func (*ClientCred) Descriptor

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

func (*ClientCred) GetMethod

func (m *ClientCred) GetMethod() string

func (*ClientCred) GetParams

func (m *ClientCred) GetParams() []byte

func (*ClientCred) GetResponse

func (m *ClientCred) GetResponse() string

func (*ClientCred) GetValue

func (m *ClientCred) GetValue() string

func (*ClientCred) ProtoMessage

func (*ClientCred) ProtoMessage()

func (*ClientCred) Reset

func (m *ClientCred) Reset()

func (*ClientCred) String

func (m *ClientCred) String() string

func (*ClientCred) XXX_DiscardUnknown

func (m *ClientCred) XXX_DiscardUnknown()

func (*ClientCred) XXX_Marshal

func (m *ClientCred) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClientCred) XXX_Merge

func (dst *ClientCred) XXX_Merge(src proto.Message)

func (*ClientCred) XXX_Size

func (m *ClientCred) XXX_Size() int

func (*ClientCred) XXX_Unmarshal

func (m *ClientCred) XXX_Unmarshal(b []byte) error

type ClientDel

type ClientDel struct {
	Id    string         `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	Topic string         `protobuf:"bytes,2,opt,name=topic" json:"topic,omitempty"`
	What  ClientDel_What `protobuf:"varint,3,opt,name=what,enum=pbx.ClientDel_What" json:"what,omitempty"`
	// Delete messages by id or range of ids
	DelSeq []*SeqRange `protobuf:"bytes,4,rep,name=del_seq,json=delSeq" json:"del_seq,omitempty"`
	// User ID of the subscription to delete
	UserId string `protobuf:"bytes,5,opt,name=user_id,json=userId" json:"user_id,omitempty"`
	// Credential to delete.
	Cred *ClientCred `protobuf:"bytes,6,opt,name=cred" json:"cred,omitempty"`
	// Request to hard-delete messages for all users, if such option is available.
	Hard                 bool     `protobuf:"varint,7,opt,name=hard" json:"hard,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

ClientDel delete messages or topic

func (*ClientDel) Descriptor

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

func (*ClientDel) GetCred

func (m *ClientDel) GetCred() *ClientCred

func (*ClientDel) GetDelSeq

func (m *ClientDel) GetDelSeq() []*SeqRange

func (*ClientDel) GetHard

func (m *ClientDel) GetHard() bool

func (*ClientDel) GetId

func (m *ClientDel) GetId() string

func (*ClientDel) GetTopic

func (m *ClientDel) GetTopic() string

func (*ClientDel) GetUserId

func (m *ClientDel) GetUserId() string

func (*ClientDel) GetWhat

func (m *ClientDel) GetWhat() ClientDel_What

func (*ClientDel) ProtoMessage

func (*ClientDel) ProtoMessage()

func (*ClientDel) Reset

func (m *ClientDel) Reset()

func (*ClientDel) String

func (m *ClientDel) String() string

func (*ClientDel) XXX_DiscardUnknown

func (m *ClientDel) XXX_DiscardUnknown()

func (*ClientDel) XXX_Marshal

func (m *ClientDel) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClientDel) XXX_Merge

func (dst *ClientDel) XXX_Merge(src proto.Message)

func (*ClientDel) XXX_Size

func (m *ClientDel) XXX_Size() int

func (*ClientDel) XXX_Unmarshal

func (m *ClientDel) XXX_Unmarshal(b []byte) error

type ClientDel_What

type ClientDel_What int32

What to delete, either "msg" to delete messages (default) or "topic" to delete the topic or "sub" to delete a subscription to topic.

const (
	ClientDel_MSG   ClientDel_What = 0
	ClientDel_TOPIC ClientDel_What = 1
	ClientDel_SUB   ClientDel_What = 2
	ClientDel_USER  ClientDel_What = 3
	ClientDel_CRED  ClientDel_What = 4
)

func (ClientDel_What) EnumDescriptor

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

func (ClientDel_What) String

func (x ClientDel_What) String() string

type ClientGet

type ClientGet struct {
	Id                   string    `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	Topic                string    `protobuf:"bytes,2,opt,name=topic" json:"topic,omitempty"`
	Query                *GetQuery `protobuf:"bytes,3,opt,name=query" json:"query,omitempty"`
	XXX_NoUnkeyedLiteral struct{}  `json:"-"`
	XXX_unrecognized     []byte    `json:"-"`
	XXX_sizecache        int32     `json:"-"`
}

Query topic state {get}

func (*ClientGet) Descriptor

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

func (*ClientGet) GetId

func (m *ClientGet) GetId() string

func (*ClientGet) GetQuery

func (m *ClientGet) GetQuery() *GetQuery

func (*ClientGet) GetTopic

func (m *ClientGet) GetTopic() string

func (*ClientGet) ProtoMessage

func (*ClientGet) ProtoMessage()

func (*ClientGet) Reset

func (m *ClientGet) Reset()

func (*ClientGet) String

func (m *ClientGet) String() string

func (*ClientGet) XXX_DiscardUnknown

func (m *ClientGet) XXX_DiscardUnknown()

func (*ClientGet) XXX_Marshal

func (m *ClientGet) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClientGet) XXX_Merge

func (dst *ClientGet) XXX_Merge(src proto.Message)

func (*ClientGet) XXX_Size

func (m *ClientGet) XXX_Size() int

func (*ClientGet) XXX_Unmarshal

func (m *ClientGet) XXX_Unmarshal(b []byte) error

type ClientHi

type ClientHi struct {
	Id                   string   `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	UserAgent            string   `protobuf:"bytes,2,opt,name=user_agent,json=userAgent" json:"user_agent,omitempty"`
	Ver                  string   `protobuf:"bytes,3,opt,name=ver" json:"ver,omitempty"`
	DeviceId             string   `protobuf:"bytes,4,opt,name=device_id,json=deviceId" json:"device_id,omitempty"`
	Lang                 string   `protobuf:"bytes,5,opt,name=lang" json:"lang,omitempty"`
	Platform             string   `protobuf:"bytes,6,opt,name=platform" json:"platform,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Client handshake

func (*ClientHi) Descriptor

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

func (*ClientHi) GetDeviceId

func (m *ClientHi) GetDeviceId() string

func (*ClientHi) GetId

func (m *ClientHi) GetId() string

func (*ClientHi) GetLang

func (m *ClientHi) GetLang() string

func (*ClientHi) GetPlatform

func (m *ClientHi) GetPlatform() string

func (*ClientHi) GetUserAgent

func (m *ClientHi) GetUserAgent() string

func (*ClientHi) GetVer

func (m *ClientHi) GetVer() string

func (*ClientHi) ProtoMessage

func (*ClientHi) ProtoMessage()

func (*ClientHi) Reset

func (m *ClientHi) Reset()

func (*ClientHi) String

func (m *ClientHi) String() string

func (*ClientHi) XXX_DiscardUnknown

func (m *ClientHi) XXX_DiscardUnknown()

func (*ClientHi) XXX_Marshal

func (m *ClientHi) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClientHi) XXX_Merge

func (dst *ClientHi) XXX_Merge(src proto.Message)

func (*ClientHi) XXX_Size

func (m *ClientHi) XXX_Size() int

func (*ClientHi) XXX_Unmarshal

func (m *ClientHi) XXX_Unmarshal(b []byte) error

type ClientLeave

type ClientLeave struct {
	Id                   string   `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	Topic                string   `protobuf:"bytes,2,opt,name=topic" json:"topic,omitempty"`
	Unsub                bool     `protobuf:"varint,3,opt,name=unsub" json:"unsub,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Unsubscribe {leave} request message

func (*ClientLeave) Descriptor

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

func (*ClientLeave) GetId

func (m *ClientLeave) GetId() string

func (*ClientLeave) GetTopic

func (m *ClientLeave) GetTopic() string

func (*ClientLeave) GetUnsub

func (m *ClientLeave) GetUnsub() bool

func (*ClientLeave) ProtoMessage

func (*ClientLeave) ProtoMessage()

func (*ClientLeave) Reset

func (m *ClientLeave) Reset()

func (*ClientLeave) String

func (m *ClientLeave) String() string

func (*ClientLeave) XXX_DiscardUnknown

func (m *ClientLeave) XXX_DiscardUnknown()

func (*ClientLeave) XXX_Marshal

func (m *ClientLeave) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClientLeave) XXX_Merge

func (dst *ClientLeave) XXX_Merge(src proto.Message)

func (*ClientLeave) XXX_Size

func (m *ClientLeave) XXX_Size() int

func (*ClientLeave) XXX_Unmarshal

func (m *ClientLeave) XXX_Unmarshal(b []byte) error

type ClientLogin

type ClientLogin struct {
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// Authentication scheme
	Scheme string `protobuf:"bytes,2,opt,name=scheme" json:"scheme,omitempty"`
	// Shared secret
	Secret []byte `protobuf:"bytes,3,opt,name=secret,proto3" json:"secret,omitempty"`
	// Credentials for verification.
	Cred                 []*ClientCred `protobuf:"bytes,4,rep,name=cred" json:"cred,omitempty"`
	XXX_NoUnkeyedLiteral struct{}      `json:"-"`
	XXX_unrecognized     []byte        `json:"-"`
	XXX_sizecache        int32         `json:"-"`
}

Login {login} message

func (*ClientLogin) Descriptor

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

func (*ClientLogin) GetCred

func (m *ClientLogin) GetCred() []*ClientCred

func (*ClientLogin) GetId

func (m *ClientLogin) GetId() string

func (*ClientLogin) GetScheme

func (m *ClientLogin) GetScheme() string

func (*ClientLogin) GetSecret

func (m *ClientLogin) GetSecret() []byte

func (*ClientLogin) ProtoMessage

func (*ClientLogin) ProtoMessage()

func (*ClientLogin) Reset

func (m *ClientLogin) Reset()

func (*ClientLogin) String

func (m *ClientLogin) String() string

func (*ClientLogin) XXX_DiscardUnknown

func (m *ClientLogin) XXX_DiscardUnknown()

func (*ClientLogin) XXX_Marshal

func (m *ClientLogin) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClientLogin) XXX_Merge

func (dst *ClientLogin) XXX_Merge(src proto.Message)

func (*ClientLogin) XXX_Size

func (m *ClientLogin) XXX_Size() int

func (*ClientLogin) XXX_Unmarshal

func (m *ClientLogin) XXX_Unmarshal(b []byte) error

type ClientMsg

type ClientMsg struct {
	// Types that are valid to be assigned to Message:
	//	*ClientMsg_Hi
	//	*ClientMsg_Acc
	//	*ClientMsg_Login
	//	*ClientMsg_Sub
	//	*ClientMsg_Leave
	//	*ClientMsg_Pub
	//	*ClientMsg_Get
	//	*ClientMsg_Set
	//	*ClientMsg_Del
	//	*ClientMsg_Note
	Message isClientMsg_Message `protobuf_oneof:"Message"`
	// Root user may send messages on behalf of other users.
	OnBehalfOf           string    `protobuf:"bytes,11,opt,name=on_behalf_of,json=onBehalfOf" json:"on_behalf_of,omitempty"`
	AuthLevel            AuthLevel `protobuf:"varint,12,opt,name=auth_level,json=authLevel,enum=pbx.AuthLevel" json:"auth_level,omitempty"`
	XXX_NoUnkeyedLiteral struct{}  `json:"-"`
	XXX_unrecognized     []byte    `json:"-"`
	XXX_sizecache        int32     `json:"-"`
}

func (*ClientMsg) Descriptor

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

func (*ClientMsg) GetAcc

func (m *ClientMsg) GetAcc() *ClientAcc

func (*ClientMsg) GetAuthLevel

func (m *ClientMsg) GetAuthLevel() AuthLevel

func (*ClientMsg) GetDel

func (m *ClientMsg) GetDel() *ClientDel

func (*ClientMsg) GetGet

func (m *ClientMsg) GetGet() *ClientGet

func (*ClientMsg) GetHi

func (m *ClientMsg) GetHi() *ClientHi

func (*ClientMsg) GetLeave

func (m *ClientMsg) GetLeave() *ClientLeave

func (*ClientMsg) GetLogin

func (m *ClientMsg) GetLogin() *ClientLogin

func (*ClientMsg) GetMessage

func (m *ClientMsg) GetMessage() isClientMsg_Message

func (*ClientMsg) GetNote

func (m *ClientMsg) GetNote() *ClientNote

func (*ClientMsg) GetOnBehalfOf

func (m *ClientMsg) GetOnBehalfOf() string

func (*ClientMsg) GetPub

func (m *ClientMsg) GetPub() *ClientPub

func (*ClientMsg) GetSet

func (m *ClientMsg) GetSet() *ClientSet

func (*ClientMsg) GetSub

func (m *ClientMsg) GetSub() *ClientSub

func (*ClientMsg) ProtoMessage

func (*ClientMsg) ProtoMessage()

func (*ClientMsg) Reset

func (m *ClientMsg) Reset()

func (*ClientMsg) String

func (m *ClientMsg) String() string

func (*ClientMsg) XXX_DiscardUnknown

func (m *ClientMsg) XXX_DiscardUnknown()

func (*ClientMsg) XXX_Marshal

func (m *ClientMsg) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClientMsg) XXX_Merge

func (dst *ClientMsg) XXX_Merge(src proto.Message)

func (*ClientMsg) XXX_OneofFuncs

func (*ClientMsg) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

func (*ClientMsg) XXX_Size

func (m *ClientMsg) XXX_Size() int

func (*ClientMsg) XXX_Unmarshal

func (m *ClientMsg) XXX_Unmarshal(b []byte) error

type ClientMsg_Acc

type ClientMsg_Acc struct {
	Acc *ClientAcc `protobuf:"bytes,2,opt,name=acc,oneof"`
}

type ClientMsg_Del

type ClientMsg_Del struct {
	Del *ClientDel `protobuf:"bytes,9,opt,name=del,oneof"`
}

type ClientMsg_Get

type ClientMsg_Get struct {
	Get *ClientGet `protobuf:"bytes,7,opt,name=get,oneof"`
}

type ClientMsg_Hi

type ClientMsg_Hi struct {
	Hi *ClientHi `protobuf:"bytes,1,opt,name=hi,oneof"`
}

type ClientMsg_Leave

type ClientMsg_Leave struct {
	Leave *ClientLeave `protobuf:"bytes,5,opt,name=leave,oneof"`
}

type ClientMsg_Login

type ClientMsg_Login struct {
	Login *ClientLogin `protobuf:"bytes,3,opt,name=login,oneof"`
}

type ClientMsg_Note

type ClientMsg_Note struct {
	Note *ClientNote `protobuf:"bytes,10,opt,name=note,oneof"`
}

type ClientMsg_Pub

type ClientMsg_Pub struct {
	Pub *ClientPub `protobuf:"bytes,6,opt,name=pub,oneof"`
}

type ClientMsg_Set

type ClientMsg_Set struct {
	Set *ClientSet `protobuf:"bytes,8,opt,name=set,oneof"`
}

type ClientMsg_Sub

type ClientMsg_Sub struct {
	Sub *ClientSub `protobuf:"bytes,4,opt,name=sub,oneof"`
}

type ClientNote

type ClientNote struct {
	Topic string `protobuf:"bytes,1,opt,name=topic" json:"topic,omitempty"`
	// what is being reported: "recv" - message received, "read" - message read, "kp" - typing notification
	What InfoNote `protobuf:"varint,2,opt,name=what,enum=pbx.InfoNote" json:"what,omitempty"`
	// Server-issued message ID being reported
	SeqId                int32    `protobuf:"varint,3,opt,name=seq_id,json=seqId" json:"seq_id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

ClientNote is a client-generated notification for topic subscribers

func (*ClientNote) Descriptor

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

func (*ClientNote) GetSeqId

func (m *ClientNote) GetSeqId() int32

func (*ClientNote) GetTopic

func (m *ClientNote) GetTopic() string

func (*ClientNote) GetWhat

func (m *ClientNote) GetWhat() InfoNote

func (*ClientNote) ProtoMessage

func (*ClientNote) ProtoMessage()

func (*ClientNote) Reset

func (m *ClientNote) Reset()

func (*ClientNote) String

func (m *ClientNote) String() string

func (*ClientNote) XXX_DiscardUnknown

func (m *ClientNote) XXX_DiscardUnknown()

func (*ClientNote) XXX_Marshal

func (m *ClientNote) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClientNote) XXX_Merge

func (dst *ClientNote) XXX_Merge(src proto.Message)

func (*ClientNote) XXX_Size

func (m *ClientNote) XXX_Size() int

func (*ClientNote) XXX_Unmarshal

func (m *ClientNote) XXX_Unmarshal(b []byte) error

type ClientPub

type ClientPub struct {
	Id                   string            `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	Topic                string            `protobuf:"bytes,2,opt,name=topic" json:"topic,omitempty"`
	NoEcho               bool              `protobuf:"varint,3,opt,name=no_echo,json=noEcho" json:"no_echo,omitempty"`
	Head                 map[string][]byte `` /* 135-byte string literal not displayed */
	Content              []byte            `protobuf:"bytes,5,opt,name=content,proto3" json:"content,omitempty"`
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_unrecognized     []byte            `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

ClientPub is client's request to publish data to topic subscribers {pub}

func (*ClientPub) Descriptor

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

func (*ClientPub) GetContent

func (m *ClientPub) GetContent() []byte

func (*ClientPub) GetHead

func (m *ClientPub) GetHead() map[string][]byte

func (*ClientPub) GetId

func (m *ClientPub) GetId() string

func (*ClientPub) GetNoEcho

func (m *ClientPub) GetNoEcho() bool

func (*ClientPub) GetTopic

func (m *ClientPub) GetTopic() string

func (*ClientPub) ProtoMessage

func (*ClientPub) ProtoMessage()

func (*ClientPub) Reset

func (m *ClientPub) Reset()

func (*ClientPub) String

func (m *ClientPub) String() string

func (*ClientPub) XXX_DiscardUnknown

func (m *ClientPub) XXX_DiscardUnknown()

func (*ClientPub) XXX_Marshal

func (m *ClientPub) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClientPub) XXX_Merge

func (dst *ClientPub) XXX_Merge(src proto.Message)

func (*ClientPub) XXX_Size

func (m *ClientPub) XXX_Size() int

func (*ClientPub) XXX_Unmarshal

func (m *ClientPub) XXX_Unmarshal(b []byte) error

type ClientReq

type ClientReq struct {
	Msg                  *ClientMsg `protobuf:"bytes,1,opt,name=msg" json:"msg,omitempty"`
	Sess                 *Session   `protobuf:"bytes,2,opt,name=sess" json:"sess,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

func (*ClientReq) Descriptor

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

func (*ClientReq) GetMsg

func (m *ClientReq) GetMsg() *ClientMsg

func (*ClientReq) GetSess

func (m *ClientReq) GetSess() *Session

func (*ClientReq) ProtoMessage

func (*ClientReq) ProtoMessage()

func (*ClientReq) Reset

func (m *ClientReq) Reset()

func (*ClientReq) String

func (m *ClientReq) String() string

func (*ClientReq) XXX_DiscardUnknown

func (m *ClientReq) XXX_DiscardUnknown()

func (*ClientReq) XXX_Marshal

func (m *ClientReq) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClientReq) XXX_Merge

func (dst *ClientReq) XXX_Merge(src proto.Message)

func (*ClientReq) XXX_Size

func (m *ClientReq) XXX_Size() int

func (*ClientReq) XXX_Unmarshal

func (m *ClientReq) XXX_Unmarshal(b []byte) error

type ClientSet

type ClientSet struct {
	Id                   string    `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	Topic                string    `protobuf:"bytes,2,opt,name=topic" json:"topic,omitempty"`
	Query                *SetQuery `protobuf:"bytes,3,opt,name=query" json:"query,omitempty"`
	XXX_NoUnkeyedLiteral struct{}  `json:"-"`
	XXX_unrecognized     []byte    `json:"-"`
	XXX_sizecache        int32     `json:"-"`
}

Update topic state {set}

func (*ClientSet) Descriptor

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

func (*ClientSet) GetId

func (m *ClientSet) GetId() string

func (*ClientSet) GetQuery

func (m *ClientSet) GetQuery() *SetQuery

func (*ClientSet) GetTopic

func (m *ClientSet) GetTopic() string

func (*ClientSet) ProtoMessage

func (*ClientSet) ProtoMessage()

func (*ClientSet) Reset

func (m *ClientSet) Reset()

func (*ClientSet) String

func (m *ClientSet) String() string

func (*ClientSet) XXX_DiscardUnknown

func (m *ClientSet) XXX_DiscardUnknown()

func (*ClientSet) XXX_Marshal

func (m *ClientSet) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClientSet) XXX_Merge

func (dst *ClientSet) XXX_Merge(src proto.Message)

func (*ClientSet) XXX_Size

func (m *ClientSet) XXX_Size() int

func (*ClientSet) XXX_Unmarshal

func (m *ClientSet) XXX_Unmarshal(b []byte) error

type ClientSub

type ClientSub struct {
	Id    string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	Topic string `protobuf:"bytes,2,opt,name=topic" json:"topic,omitempty"`
	// mirrors {set}
	SetQuery *SetQuery `protobuf:"bytes,3,opt,name=set_query,json=setQuery" json:"set_query,omitempty"`
	// mirrors {get}
	GetQuery             *GetQuery `protobuf:"bytes,4,opt,name=get_query,json=getQuery" json:"get_query,omitempty"`
	Background           bool      `protobuf:"varint,5,opt,name=background" json:"background,omitempty"`
	XXX_NoUnkeyedLiteral struct{}  `json:"-"`
	XXX_unrecognized     []byte    `json:"-"`
	XXX_sizecache        int32     `json:"-"`
}

Subscription request {sub} message

func (*ClientSub) Descriptor

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

func (*ClientSub) GetBackground

func (m *ClientSub) GetBackground() bool

func (*ClientSub) GetGetQuery

func (m *ClientSub) GetGetQuery() *GetQuery

func (*ClientSub) GetId

func (m *ClientSub) GetId() string

func (*ClientSub) GetSetQuery

func (m *ClientSub) GetSetQuery() *SetQuery

func (*ClientSub) GetTopic

func (m *ClientSub) GetTopic() string

func (*ClientSub) ProtoMessage

func (*ClientSub) ProtoMessage()

func (*ClientSub) Reset

func (m *ClientSub) Reset()

func (*ClientSub) String

func (m *ClientSub) String() string

func (*ClientSub) XXX_DiscardUnknown

func (m *ClientSub) XXX_DiscardUnknown()

func (*ClientSub) XXX_Marshal

func (m *ClientSub) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ClientSub) XXX_Merge

func (dst *ClientSub) XXX_Merge(src proto.Message)

func (*ClientSub) XXX_Size

func (m *ClientSub) XXX_Size() int

func (*ClientSub) XXX_Unmarshal

func (m *ClientSub) XXX_Unmarshal(b []byte) error

type Crud

type Crud int32
const (
	Crud_CREATE Crud = 0
	Crud_UPDATE Crud = 1
	Crud_DELETE Crud = 2
)

func (Crud) EnumDescriptor

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

func (Crud) String

func (x Crud) String() string

type DefaultAcsMode

type DefaultAcsMode struct {
	Auth                 string   `protobuf:"bytes,1,opt,name=auth" json:"auth,omitempty"`
	Anon                 string   `protobuf:"bytes,2,opt,name=anon" json:"anon,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Topic default access mode

func (*DefaultAcsMode) Descriptor

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

func (*DefaultAcsMode) GetAnon

func (m *DefaultAcsMode) GetAnon() string

func (*DefaultAcsMode) GetAuth

func (m *DefaultAcsMode) GetAuth() string

func (*DefaultAcsMode) ProtoMessage

func (*DefaultAcsMode) ProtoMessage()

func (*DefaultAcsMode) Reset

func (m *DefaultAcsMode) Reset()

func (*DefaultAcsMode) String

func (m *DefaultAcsMode) String() string

func (*DefaultAcsMode) XXX_DiscardUnknown

func (m *DefaultAcsMode) XXX_DiscardUnknown()

func (*DefaultAcsMode) XXX_Marshal

func (m *DefaultAcsMode) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DefaultAcsMode) XXX_Merge

func (dst *DefaultAcsMode) XXX_Merge(src proto.Message)

func (*DefaultAcsMode) XXX_Size

func (m *DefaultAcsMode) XXX_Size() int

func (*DefaultAcsMode) XXX_Unmarshal

func (m *DefaultAcsMode) XXX_Unmarshal(b []byte) error

type DelValues

type DelValues struct {
	DelId                int32       `protobuf:"varint,1,opt,name=del_id,json=delId" json:"del_id,omitempty"`
	DelSeq               []*SeqRange `protobuf:"bytes,2,rep,name=del_seq,json=delSeq" json:"del_seq,omitempty"`
	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
	XXX_unrecognized     []byte      `json:"-"`
	XXX_sizecache        int32       `json:"-"`
}

func (*DelValues) Descriptor

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

func (*DelValues) GetDelId

func (m *DelValues) GetDelId() int32

func (*DelValues) GetDelSeq

func (m *DelValues) GetDelSeq() []*SeqRange

func (*DelValues) ProtoMessage

func (*DelValues) ProtoMessage()

func (*DelValues) Reset

func (m *DelValues) Reset()

func (*DelValues) String

func (m *DelValues) String() string

func (*DelValues) XXX_DiscardUnknown

func (m *DelValues) XXX_DiscardUnknown()

func (*DelValues) XXX_Marshal

func (m *DelValues) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DelValues) XXX_Merge

func (dst *DelValues) XXX_Merge(src proto.Message)

func (*DelValues) XXX_Size

func (m *DelValues) XXX_Size() int

func (*DelValues) XXX_Unmarshal

func (m *DelValues) XXX_Unmarshal(b []byte) error

type GetOpts

type GetOpts struct {
	// Timestamp in milliseconds since epoch 01/01/1970
	IfModifiedSince int64 `protobuf:"varint,1,opt,name=if_modified_since,json=ifModifiedSince" json:"if_modified_since,omitempty"`
	// Limit search to this user ID
	User string `protobuf:"bytes,2,opt,name=user" json:"user,omitempty"`
	// Limit search results to one topic;
	Topic string `protobuf:"bytes,3,opt,name=topic" json:"topic,omitempty"`
	// Load messages with seq id equal or greater than this
	SinceId int32 `protobuf:"varint,4,opt,name=since_id,json=sinceId" json:"since_id,omitempty"`
	// Load messages with seq id lower than this
	BeforeId int32 `protobuf:"varint,5,opt,name=before_id,json=beforeId" json:"before_id,omitempty"`
	// Maximum number of results to return
	Limit                int32    `protobuf:"varint,6,opt,name=limit" json:"limit,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*GetOpts) Descriptor

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

func (*GetOpts) GetBeforeId

func (m *GetOpts) GetBeforeId() int32

func (*GetOpts) GetIfModifiedSince

func (m *GetOpts) GetIfModifiedSince() int64

func (*GetOpts) GetLimit

func (m *GetOpts) GetLimit() int32

func (*GetOpts) GetSinceId

func (m *GetOpts) GetSinceId() int32

func (*GetOpts) GetTopic

func (m *GetOpts) GetTopic() string

func (*GetOpts) GetUser

func (m *GetOpts) GetUser() string

func (*GetOpts) ProtoMessage

func (*GetOpts) ProtoMessage()

func (*GetOpts) Reset

func (m *GetOpts) Reset()

func (*GetOpts) String

func (m *GetOpts) String() string

func (*GetOpts) XXX_DiscardUnknown

func (m *GetOpts) XXX_DiscardUnknown()

func (*GetOpts) XXX_Marshal

func (m *GetOpts) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetOpts) XXX_Merge

func (dst *GetOpts) XXX_Merge(src proto.Message)

func (*GetOpts) XXX_Size

func (m *GetOpts) XXX_Size() int

func (*GetOpts) XXX_Unmarshal

func (m *GetOpts) XXX_Unmarshal(b []byte) error

type GetQuery

type GetQuery struct {
	What string `protobuf:"bytes,1,opt,name=what" json:"what,omitempty"`
	// Parameters of "desc" request
	Desc *GetOpts `protobuf:"bytes,2,opt,name=desc" json:"desc,omitempty"`
	// Parameters of "sub" request
	Sub *GetOpts `protobuf:"bytes,3,opt,name=sub" json:"sub,omitempty"`
	// Parameters of "data" request
	Data                 *GetOpts `protobuf:"bytes,4,opt,name=data" json:"data,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*GetQuery) Descriptor

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

func (*GetQuery) GetData

func (m *GetQuery) GetData() *GetOpts

func (*GetQuery) GetDesc

func (m *GetQuery) GetDesc() *GetOpts

func (*GetQuery) GetSub

func (m *GetQuery) GetSub() *GetOpts

func (*GetQuery) GetWhat

func (m *GetQuery) GetWhat() string

func (*GetQuery) ProtoMessage

func (*GetQuery) ProtoMessage()

func (*GetQuery) Reset

func (m *GetQuery) Reset()

func (*GetQuery) String

func (m *GetQuery) String() string

func (*GetQuery) XXX_DiscardUnknown

func (m *GetQuery) XXX_DiscardUnknown()

func (*GetQuery) XXX_Marshal

func (m *GetQuery) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetQuery) XXX_Merge

func (dst *GetQuery) XXX_Merge(src proto.Message)

func (*GetQuery) XXX_Size

func (m *GetQuery) XXX_Size() int

func (*GetQuery) XXX_Unmarshal

func (m *GetQuery) XXX_Unmarshal(b []byte) error

type InfoNote

type InfoNote int32
const (
	InfoNote_READ InfoNote = 0
	InfoNote_RECV InfoNote = 1
	InfoNote_KP   InfoNote = 2
)

func (InfoNote) EnumDescriptor

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

func (InfoNote) String

func (x InfoNote) String() string

type MessageEvent

type MessageEvent struct {
	Action               Crud        `protobuf:"varint,1,opt,name=action,enum=pbx.Crud" json:"action,omitempty"`
	Msg                  *ServerData `protobuf:"bytes,2,opt,name=msg" json:"msg,omitempty"`
	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
	XXX_unrecognized     []byte      `json:"-"`
	XXX_sizecache        int32       `json:"-"`
}

func (*MessageEvent) Descriptor

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

func (*MessageEvent) GetAction

func (m *MessageEvent) GetAction() Crud

func (*MessageEvent) GetMsg

func (m *MessageEvent) GetMsg() *ServerData

func (*MessageEvent) ProtoMessage

func (*MessageEvent) ProtoMessage()

func (*MessageEvent) Reset

func (m *MessageEvent) Reset()

func (*MessageEvent) String

func (m *MessageEvent) String() string

func (*MessageEvent) XXX_DiscardUnknown

func (m *MessageEvent) XXX_DiscardUnknown()

func (*MessageEvent) XXX_Marshal

func (m *MessageEvent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MessageEvent) XXX_Merge

func (dst *MessageEvent) XXX_Merge(src proto.Message)

func (*MessageEvent) XXX_Size

func (m *MessageEvent) XXX_Size() int

func (*MessageEvent) XXX_Unmarshal

func (m *MessageEvent) XXX_Unmarshal(b []byte) error

type NodeClient

type NodeClient interface {
	// Client sends a stream of ClientMsg, server responds with a stream of ServerMsg
	MessageLoop(ctx context.Context, opts ...grpc.CallOption) (Node_MessageLoopClient, error)
}

func NewNodeClient

func NewNodeClient(cc *grpc.ClientConn) NodeClient

type NodeServer

type NodeServer interface {
	// Client sends a stream of ClientMsg, server responds with a stream of ServerMsg
	MessageLoop(Node_MessageLoopServer) error
}

type Node_MessageLoopClient

type Node_MessageLoopClient interface {
	Send(*ClientMsg) error
	Recv() (*ServerMsg, error)
	grpc.ClientStream
}

type Node_MessageLoopServer

type Node_MessageLoopServer interface {
	Send(*ServerMsg) error
	Recv() (*ClientMsg, error)
	grpc.ServerStream
}

type PluginClient

type PluginClient interface {
	// This plugin method is called by Tinode server for every message received from the clients. The
	// method returns a ServerCtrl message. Non-zero ServerCtrl.code indicates that no further
	// processing is needed. The Tinode server will generate a {ctrl} message from the returned ServerCtrl
	// and forward it to the client session.
	// ServerCtrl.code equals to 0 instructs the server to continue with default processing of the client message.
	FireHose(ctx context.Context, in *ClientReq, opts ...grpc.CallOption) (*ServerResp, error)
	// An alteranative user and topic discovery mechanism.
	// A search request issued on a 'fnd' topic. This method is called to generate an alternative result set.
	Find(ctx context.Context, in *SearchQuery, opts ...grpc.CallOption) (*SearchFound, error)
	// Account created, updated or deleted
	Account(ctx context.Context, in *AccountEvent, opts ...grpc.CallOption) (*Unused, error)
	// Topic created, updated [or deleted -- not supported yet]
	Topic(ctx context.Context, in *TopicEvent, opts ...grpc.CallOption) (*Unused, error)
	// Subscription created, updated or deleted
	Subscription(ctx context.Context, in *SubscriptionEvent, opts ...grpc.CallOption) (*Unused, error)
	// Message published or deleted
	Message(ctx context.Context, in *MessageEvent, opts ...grpc.CallOption) (*Unused, error)
}

func NewPluginClient

func NewPluginClient(cc *grpc.ClientConn) PluginClient

type PluginServer

type PluginServer interface {
	// This plugin method is called by Tinode server for every message received from the clients. The
	// method returns a ServerCtrl message. Non-zero ServerCtrl.code indicates that no further
	// processing is needed. The Tinode server will generate a {ctrl} message from the returned ServerCtrl
	// and forward it to the client session.
	// ServerCtrl.code equals to 0 instructs the server to continue with default processing of the client message.
	FireHose(context.Context, *ClientReq) (*ServerResp, error)
	// An alteranative user and topic discovery mechanism.
	// A search request issued on a 'fnd' topic. This method is called to generate an alternative result set.
	Find(context.Context, *SearchQuery) (*SearchFound, error)
	// Account created, updated or deleted
	Account(context.Context, *AccountEvent) (*Unused, error)
	// Topic created, updated [or deleted -- not supported yet]
	Topic(context.Context, *TopicEvent) (*Unused, error)
	// Subscription created, updated or deleted
	Subscription(context.Context, *SubscriptionEvent) (*Unused, error)
	// Message published or deleted
	Message(context.Context, *MessageEvent) (*Unused, error)
}

type RespCode

type RespCode int32

Plugin response codes

const (
	// Instruct Tinode server to continue with default processing of the client request.
	RespCode_CONTINUE RespCode = 0
	// Drop the request as if the client did not send it
	RespCode_DROP RespCode = 1
	// Send the the provided response to the client.
	RespCode_RESPOND RespCode = 2
	// Replace client's original request with the provided request then continue with
	// processing.
	RespCode_REPLACE RespCode = 3
)

func (RespCode) EnumDescriptor

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

func (RespCode) String

func (x RespCode) String() string

type SearchFound

type SearchFound struct {
	Status RespCode `protobuf:"varint,1,opt,name=status,enum=pbx.RespCode" json:"status,omitempty"`
	// New search query If status == REPLACE, otherwise unset.
	Query string `protobuf:"bytes,2,opt,name=query" json:"query,omitempty"`
	// Search results.
	Result               []*TopicSub `protobuf:"bytes,3,rep,name=result" json:"result,omitempty"`
	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
	XXX_unrecognized     []byte      `json:"-"`
	XXX_sizecache        int32       `json:"-"`
}

func (*SearchFound) Descriptor

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

func (*SearchFound) GetQuery

func (m *SearchFound) GetQuery() string

func (*SearchFound) GetResult

func (m *SearchFound) GetResult() []*TopicSub

func (*SearchFound) GetStatus

func (m *SearchFound) GetStatus() RespCode

func (*SearchFound) ProtoMessage

func (*SearchFound) ProtoMessage()

func (*SearchFound) Reset

func (m *SearchFound) Reset()

func (*SearchFound) String

func (m *SearchFound) String() string

func (*SearchFound) XXX_DiscardUnknown

func (m *SearchFound) XXX_DiscardUnknown()

func (*SearchFound) XXX_Marshal

func (m *SearchFound) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*SearchFound) XXX_Merge

func (dst *SearchFound) XXX_Merge(src proto.Message)

func (*SearchFound) XXX_Size

func (m *SearchFound) XXX_Size() int

func (*SearchFound) XXX_Unmarshal

func (m *SearchFound) XXX_Unmarshal(b []byte) error

type SearchQuery

type SearchQuery struct {
	UserId               string   `protobuf:"bytes,1,opt,name=user_id,json=userId" json:"user_id,omitempty"`
	Query                string   `protobuf:"bytes,2,opt,name=query" json:"query,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*SearchQuery) Descriptor

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

func (*SearchQuery) GetQuery

func (m *SearchQuery) GetQuery() string

func (*SearchQuery) GetUserId

func (m *SearchQuery) GetUserId() string

func (*SearchQuery) ProtoMessage

func (*SearchQuery) ProtoMessage()

func (*SearchQuery) Reset

func (m *SearchQuery) Reset()

func (*SearchQuery) String

func (m *SearchQuery) String() string

func (*SearchQuery) XXX_DiscardUnknown

func (m *SearchQuery) XXX_DiscardUnknown()

func (*SearchQuery) XXX_Marshal

func (m *SearchQuery) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*SearchQuery) XXX_Merge

func (dst *SearchQuery) XXX_Merge(src proto.Message)

func (*SearchQuery) XXX_Size

func (m *SearchQuery) XXX_Size() int

func (*SearchQuery) XXX_Unmarshal

func (m *SearchQuery) XXX_Unmarshal(b []byte) error

type SeqRange

type SeqRange struct {
	Low                  int32    `protobuf:"varint,1,opt,name=low" json:"low,omitempty"`
	Hi                   int32    `protobuf:"varint,2,opt,name=hi" json:"hi,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*SeqRange) Descriptor

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

func (*SeqRange) GetHi

func (m *SeqRange) GetHi() int32

func (*SeqRange) GetLow

func (m *SeqRange) GetLow() int32

func (*SeqRange) ProtoMessage

func (*SeqRange) ProtoMessage()

func (*SeqRange) Reset

func (m *SeqRange) Reset()

func (*SeqRange) String

func (m *SeqRange) String() string

func (*SeqRange) XXX_DiscardUnknown

func (m *SeqRange) XXX_DiscardUnknown()

func (*SeqRange) XXX_Marshal

func (m *SeqRange) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*SeqRange) XXX_Merge

func (dst *SeqRange) XXX_Merge(src proto.Message)

func (*SeqRange) XXX_Size

func (m *SeqRange) XXX_Size() int

func (*SeqRange) XXX_Unmarshal

func (m *SeqRange) XXX_Unmarshal(b []byte) error

type ServerCred

type ServerCred struct {
	// Credential type, i.e. `email` or `tel`.
	Method string `protobuf:"bytes,1,opt,name=method" json:"method,omitempty"`
	// Value to verify, i.e. `user@example.com` or `+18003287448`
	Value string `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
	// Indicator that the credential is validated
	Done                 bool     `protobuf:"varint,3,opt,name=done" json:"done,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Credentials

func (*ServerCred) Descriptor

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

func (*ServerCred) GetDone

func (m *ServerCred) GetDone() bool

func (*ServerCred) GetMethod

func (m *ServerCred) GetMethod() string

func (*ServerCred) GetValue

func (m *ServerCred) GetValue() string

func (*ServerCred) ProtoMessage

func (*ServerCred) ProtoMessage()

func (*ServerCred) Reset

func (m *ServerCred) Reset()

func (*ServerCred) String

func (m *ServerCred) String() string

func (*ServerCred) XXX_DiscardUnknown

func (m *ServerCred) XXX_DiscardUnknown()

func (*ServerCred) XXX_Marshal

func (m *ServerCred) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ServerCred) XXX_Merge

func (dst *ServerCred) XXX_Merge(src proto.Message)

func (*ServerCred) XXX_Size

func (m *ServerCred) XXX_Size() int

func (*ServerCred) XXX_Unmarshal

func (m *ServerCred) XXX_Unmarshal(b []byte) error

type ServerCtrl

type ServerCtrl struct {
	Id                   string            `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	Topic                string            `protobuf:"bytes,2,opt,name=topic" json:"topic,omitempty"`
	Code                 int32             `protobuf:"varint,3,opt,name=code" json:"code,omitempty"`
	Text                 string            `protobuf:"bytes,4,opt,name=text" json:"text,omitempty"`
	Params               map[string][]byte `` /* 139-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_unrecognized     []byte            `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

{ctrl} message

func (*ServerCtrl) Descriptor

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

func (*ServerCtrl) GetCode

func (m *ServerCtrl) GetCode() int32

func (*ServerCtrl) GetId

func (m *ServerCtrl) GetId() string

func (*ServerCtrl) GetParams

func (m *ServerCtrl) GetParams() map[string][]byte

func (*ServerCtrl) GetText

func (m *ServerCtrl) GetText() string

func (*ServerCtrl) GetTopic

func (m *ServerCtrl) GetTopic() string

func (*ServerCtrl) ProtoMessage

func (*ServerCtrl) ProtoMessage()

func (*ServerCtrl) Reset

func (m *ServerCtrl) Reset()

func (*ServerCtrl) String

func (m *ServerCtrl) String() string

func (*ServerCtrl) XXX_DiscardUnknown

func (m *ServerCtrl) XXX_DiscardUnknown()

func (*ServerCtrl) XXX_Marshal

func (m *ServerCtrl) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ServerCtrl) XXX_Merge

func (dst *ServerCtrl) XXX_Merge(src proto.Message)

func (*ServerCtrl) XXX_Size

func (m *ServerCtrl) XXX_Size() int

func (*ServerCtrl) XXX_Unmarshal

func (m *ServerCtrl) XXX_Unmarshal(b []byte) error

type ServerData

type ServerData struct {
	Topic string `protobuf:"bytes,1,opt,name=topic" json:"topic,omitempty"`
	// ID of the user who originated the message as {pub}, could be empty if sent by the system
	FromUserId string `protobuf:"bytes,2,opt,name=from_user_id,json=fromUserId" json:"from_user_id,omitempty"`
	// Timestamp when the message was sent.
	Timestamp int64 `protobuf:"varint,7,opt,name=timestamp" json:"timestamp,omitempty"`
	// Timestamp when the message was deleted or 0. Milliseconds since the epoch 01/01/1970
	DeletedAt            int64             `protobuf:"varint,3,opt,name=deleted_at,json=deletedAt" json:"deleted_at,omitempty"`
	SeqId                int32             `protobuf:"varint,4,opt,name=seq_id,json=seqId" json:"seq_id,omitempty"`
	Head                 map[string][]byte `` /* 135-byte string literal not displayed */
	Content              []byte            `protobuf:"bytes,6,opt,name=content,proto3" json:"content,omitempty"`
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_unrecognized     []byte            `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

{data} message

func (*ServerData) Descriptor

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

func (*ServerData) GetContent

func (m *ServerData) GetContent() []byte

func (*ServerData) GetDeletedAt

func (m *ServerData) GetDeletedAt() int64

func (*ServerData) GetFromUserId

func (m *ServerData) GetFromUserId() string

func (*ServerData) GetHead

func (m *ServerData) GetHead() map[string][]byte

func (*ServerData) GetSeqId

func (m *ServerData) GetSeqId() int32

func (*ServerData) GetTimestamp

func (m *ServerData) GetTimestamp() int64

func (*ServerData) GetTopic

func (m *ServerData) GetTopic() string

func (*ServerData) ProtoMessage

func (*ServerData) ProtoMessage()

func (*ServerData) Reset

func (m *ServerData) Reset()

func (*ServerData) String

func (m *ServerData) String() string

func (*ServerData) XXX_DiscardUnknown

func (m *ServerData) XXX_DiscardUnknown()

func (*ServerData) XXX_Marshal

func (m *ServerData) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ServerData) XXX_Merge

func (dst *ServerData) XXX_Merge(src proto.Message)

func (*ServerData) XXX_Size

func (m *ServerData) XXX_Size() int

func (*ServerData) XXX_Unmarshal

func (m *ServerData) XXX_Unmarshal(b []byte) error

type ServerInfo

type ServerInfo struct {
	Topic                string   `protobuf:"bytes,1,opt,name=topic" json:"topic,omitempty"`
	FromUserId           string   `protobuf:"bytes,2,opt,name=from_user_id,json=fromUserId" json:"from_user_id,omitempty"`
	What                 InfoNote `protobuf:"varint,3,opt,name=what,enum=pbx.InfoNote" json:"what,omitempty"`
	SeqId                int32    `protobuf:"varint,4,opt,name=seq_id,json=seqId" json:"seq_id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

{info} message: server-side copy of ClientNote with From added

func (*ServerInfo) Descriptor

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

func (*ServerInfo) GetFromUserId

func (m *ServerInfo) GetFromUserId() string

func (*ServerInfo) GetSeqId

func (m *ServerInfo) GetSeqId() int32

func (*ServerInfo) GetTopic

func (m *ServerInfo) GetTopic() string

func (*ServerInfo) GetWhat

func (m *ServerInfo) GetWhat() InfoNote

func (*ServerInfo) ProtoMessage

func (*ServerInfo) ProtoMessage()

func (*ServerInfo) Reset

func (m *ServerInfo) Reset()

func (*ServerInfo) String

func (m *ServerInfo) String() string

func (*ServerInfo) XXX_DiscardUnknown

func (m *ServerInfo) XXX_DiscardUnknown()

func (*ServerInfo) XXX_Marshal

func (m *ServerInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ServerInfo) XXX_Merge

func (dst *ServerInfo) XXX_Merge(src proto.Message)

func (*ServerInfo) XXX_Size

func (m *ServerInfo) XXX_Size() int

func (*ServerInfo) XXX_Unmarshal

func (m *ServerInfo) XXX_Unmarshal(b []byte) error

type ServerMeta

type ServerMeta struct {
	Id                   string        `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	Topic                string        `protobuf:"bytes,2,opt,name=topic" json:"topic,omitempty"`
	Desc                 *TopicDesc    `protobuf:"bytes,3,opt,name=desc" json:"desc,omitempty"`
	Sub                  []*TopicSub   `protobuf:"bytes,4,rep,name=sub" json:"sub,omitempty"`
	Del                  *DelValues    `protobuf:"bytes,5,opt,name=del" json:"del,omitempty"`
	Tags                 []string      `protobuf:"bytes,6,rep,name=tags" json:"tags,omitempty"`
	Cred                 []*ServerCred `protobuf:"bytes,7,rep,name=cred" json:"cred,omitempty"`
	XXX_NoUnkeyedLiteral struct{}      `json:"-"`
	XXX_unrecognized     []byte        `json:"-"`
	XXX_sizecache        int32         `json:"-"`
}

{meta} message

func (*ServerMeta) Descriptor

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

func (*ServerMeta) GetCred

func (m *ServerMeta) GetCred() []*ServerCred

func (*ServerMeta) GetDel

func (m *ServerMeta) GetDel() *DelValues

func (*ServerMeta) GetDesc

func (m *ServerMeta) GetDesc() *TopicDesc

func (*ServerMeta) GetId

func (m *ServerMeta) GetId() string

func (*ServerMeta) GetSub

func (m *ServerMeta) GetSub() []*TopicSub

func (*ServerMeta) GetTags

func (m *ServerMeta) GetTags() []string

func (*ServerMeta) GetTopic

func (m *ServerMeta) GetTopic() string

func (*ServerMeta) ProtoMessage

func (*ServerMeta) ProtoMessage()

func (*ServerMeta) Reset

func (m *ServerMeta) Reset()

func (*ServerMeta) String

func (m *ServerMeta) String() string

func (*ServerMeta) XXX_DiscardUnknown

func (m *ServerMeta) XXX_DiscardUnknown()

func (*ServerMeta) XXX_Marshal

func (m *ServerMeta) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ServerMeta) XXX_Merge

func (dst *ServerMeta) XXX_Merge(src proto.Message)

func (*ServerMeta) XXX_Size

func (m *ServerMeta) XXX_Size() int

func (*ServerMeta) XXX_Unmarshal

func (m *ServerMeta) XXX_Unmarshal(b []byte) error

type ServerMsg

type ServerMsg struct {
	// Types that are valid to be assigned to Message:
	//	*ServerMsg_Ctrl
	//	*ServerMsg_Data
	//	*ServerMsg_Pres
	//	*ServerMsg_Meta
	//	*ServerMsg_Info
	Message isServerMsg_Message `protobuf_oneof:"Message"`
	// When response is sent to Root, send internal topic name too.
	Topic                string   `protobuf:"bytes,6,opt,name=topic" json:"topic,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Cumulative message

func (*ServerMsg) Descriptor

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

func (*ServerMsg) GetCtrl

func (m *ServerMsg) GetCtrl() *ServerCtrl

func (*ServerMsg) GetData

func (m *ServerMsg) GetData() *ServerData

func (*ServerMsg) GetInfo

func (m *ServerMsg) GetInfo() *ServerInfo

func (*ServerMsg) GetMessage

func (m *ServerMsg) GetMessage() isServerMsg_Message

func (*ServerMsg) GetMeta

func (m *ServerMsg) GetMeta() *ServerMeta

func (*ServerMsg) GetPres

func (m *ServerMsg) GetPres() *ServerPres

func (*ServerMsg) GetTopic

func (m *ServerMsg) GetTopic() string

func (*ServerMsg) ProtoMessage

func (*ServerMsg) ProtoMessage()

func (*ServerMsg) Reset

func (m *ServerMsg) Reset()

func (*ServerMsg) String

func (m *ServerMsg) String() string

func (*ServerMsg) XXX_DiscardUnknown

func (m *ServerMsg) XXX_DiscardUnknown()

func (*ServerMsg) XXX_Marshal

func (m *ServerMsg) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ServerMsg) XXX_Merge

func (dst *ServerMsg) XXX_Merge(src proto.Message)

func (*ServerMsg) XXX_OneofFuncs

func (*ServerMsg) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

func (*ServerMsg) XXX_Size

func (m *ServerMsg) XXX_Size() int

func (*ServerMsg) XXX_Unmarshal

func (m *ServerMsg) XXX_Unmarshal(b []byte) error

type ServerMsg_Ctrl

type ServerMsg_Ctrl struct {
	Ctrl *ServerCtrl `protobuf:"bytes,1,opt,name=ctrl,oneof"`
}

type ServerMsg_Data

type ServerMsg_Data struct {
	Data *ServerData `protobuf:"bytes,2,opt,name=data,oneof"`
}

type ServerMsg_Info

type ServerMsg_Info struct {
	Info *ServerInfo `protobuf:"bytes,5,opt,name=info,oneof"`
}

type ServerMsg_Meta

type ServerMsg_Meta struct {
	Meta *ServerMeta `protobuf:"bytes,4,opt,name=meta,oneof"`
}

type ServerMsg_Pres

type ServerMsg_Pres struct {
	Pres *ServerPres `protobuf:"bytes,3,opt,name=pres,oneof"`
}

type ServerPres

type ServerPres struct {
	Topic                string          `protobuf:"bytes,1,opt,name=topic" json:"topic,omitempty"`
	Src                  string          `protobuf:"bytes,2,opt,name=src" json:"src,omitempty"`
	What                 ServerPres_What `protobuf:"varint,3,opt,name=what,enum=pbx.ServerPres_What" json:"what,omitempty"`
	UserAgent            string          `protobuf:"bytes,4,opt,name=user_agent,json=userAgent" json:"user_agent,omitempty"`
	SeqId                int32           `protobuf:"varint,5,opt,name=seq_id,json=seqId" json:"seq_id,omitempty"`
	DelId                int32           `protobuf:"varint,6,opt,name=del_id,json=delId" json:"del_id,omitempty"`
	DelSeq               []*SeqRange     `protobuf:"bytes,7,rep,name=del_seq,json=delSeq" json:"del_seq,omitempty"`
	TargetUserId         string          `protobuf:"bytes,8,opt,name=target_user_id,json=targetUserId" json:"target_user_id,omitempty"`
	ActorUserId          string          `protobuf:"bytes,9,opt,name=actor_user_id,json=actorUserId" json:"actor_user_id,omitempty"`
	Acs                  *AccessMode     `protobuf:"bytes,10,opt,name=acs" json:"acs,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

{pres} message

func (*ServerPres) Descriptor

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

func (*ServerPres) GetAcs

func (m *ServerPres) GetAcs() *AccessMode

func (*ServerPres) GetActorUserId

func (m *ServerPres) GetActorUserId() string

func (*ServerPres) GetDelId

func (m *ServerPres) GetDelId() int32

func (*ServerPres) GetDelSeq

func (m *ServerPres) GetDelSeq() []*SeqRange

func (*ServerPres) GetSeqId

func (m *ServerPres) GetSeqId() int32

func (*ServerPres) GetSrc

func (m *ServerPres) GetSrc() string

func (*ServerPres) GetTargetUserId

func (m *ServerPres) GetTargetUserId() string

func (*ServerPres) GetTopic

func (m *ServerPres) GetTopic() string

func (*ServerPres) GetUserAgent

func (m *ServerPres) GetUserAgent() string

func (*ServerPres) GetWhat

func (m *ServerPres) GetWhat() ServerPres_What

func (*ServerPres) ProtoMessage

func (*ServerPres) ProtoMessage()

func (*ServerPres) Reset

func (m *ServerPres) Reset()

func (*ServerPres) String

func (m *ServerPres) String() string

func (*ServerPres) XXX_DiscardUnknown

func (m *ServerPres) XXX_DiscardUnknown()

func (*ServerPres) XXX_Marshal

func (m *ServerPres) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ServerPres) XXX_Merge

func (dst *ServerPres) XXX_Merge(src proto.Message)

func (*ServerPres) XXX_Size

func (m *ServerPres) XXX_Size() int

func (*ServerPres) XXX_Unmarshal

func (m *ServerPres) XXX_Unmarshal(b []byte) error

type ServerPres_What

type ServerPres_What int32
const (
	ServerPres_ON   ServerPres_What = 0
	ServerPres_OFF  ServerPres_What = 1
	ServerPres_UA   ServerPres_What = 3
	ServerPres_UPD  ServerPres_What = 4
	ServerPres_GONE ServerPres_What = 5
	ServerPres_ACS  ServerPres_What = 6
	ServerPres_TERM ServerPres_What = 7
	ServerPres_MSG  ServerPres_What = 8
	ServerPres_READ ServerPres_What = 9
	ServerPres_RECV ServerPres_What = 10
	ServerPres_DEL  ServerPres_What = 11
	ServerPres_TAGS ServerPres_What = 12
)

func (ServerPres_What) EnumDescriptor

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

func (ServerPres_What) String

func (x ServerPres_What) String() string

type ServerResp

type ServerResp struct {
	Status               RespCode   `protobuf:"varint,1,opt,name=status,enum=pbx.RespCode" json:"status,omitempty"`
	Srvmsg               *ServerMsg `protobuf:"bytes,2,opt,name=srvmsg" json:"srvmsg,omitempty"`
	Clmsg                *ClientMsg `protobuf:"bytes,3,opt,name=clmsg" json:"clmsg,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

func (*ServerResp) Descriptor

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

func (*ServerResp) GetClmsg

func (m *ServerResp) GetClmsg() *ClientMsg

func (*ServerResp) GetSrvmsg

func (m *ServerResp) GetSrvmsg() *ServerMsg

func (*ServerResp) GetStatus

func (m *ServerResp) GetStatus() RespCode

func (*ServerResp) ProtoMessage

func (*ServerResp) ProtoMessage()

func (*ServerResp) Reset

func (m *ServerResp) Reset()

func (*ServerResp) String

func (m *ServerResp) String() string

func (*ServerResp) XXX_DiscardUnknown

func (m *ServerResp) XXX_DiscardUnknown()

func (*ServerResp) XXX_Marshal

func (m *ServerResp) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ServerResp) XXX_Merge

func (dst *ServerResp) XXX_Merge(src proto.Message)

func (*ServerResp) XXX_Size

func (m *ServerResp) XXX_Size() int

func (*ServerResp) XXX_Unmarshal

func (m *ServerResp) XXX_Unmarshal(b []byte) error

type Session

type Session struct {
	SessionId            string    `protobuf:"bytes,1,opt,name=session_id,json=sessionId" json:"session_id,omitempty"`
	UserId               string    `protobuf:"bytes,2,opt,name=user_id,json=userId" json:"user_id,omitempty"`
	AuthLevel            AuthLevel `protobuf:"varint,3,opt,name=auth_level,json=authLevel,enum=pbx.AuthLevel" json:"auth_level,omitempty"`
	RemoteAddr           string    `protobuf:"bytes,4,opt,name=remote_addr,json=remoteAddr" json:"remote_addr,omitempty"`
	UserAgent            string    `protobuf:"bytes,5,opt,name=user_agent,json=userAgent" json:"user_agent,omitempty"`
	DeviceId             string    `protobuf:"bytes,6,opt,name=device_id,json=deviceId" json:"device_id,omitempty"`
	Language             string    `protobuf:"bytes,7,opt,name=language" json:"language,omitempty"`
	XXX_NoUnkeyedLiteral struct{}  `json:"-"`
	XXX_unrecognized     []byte    `json:"-"`
	XXX_sizecache        int32     `json:"-"`
}

Context message

func (*Session) Descriptor

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

func (*Session) GetAuthLevel

func (m *Session) GetAuthLevel() AuthLevel

func (*Session) GetDeviceId

func (m *Session) GetDeviceId() string

func (*Session) GetLanguage

func (m *Session) GetLanguage() string

func (*Session) GetRemoteAddr

func (m *Session) GetRemoteAddr() string

func (*Session) GetSessionId

func (m *Session) GetSessionId() string

func (*Session) GetUserAgent

func (m *Session) GetUserAgent() string

func (*Session) GetUserId

func (m *Session) GetUserId() string

func (*Session) ProtoMessage

func (*Session) ProtoMessage()

func (*Session) Reset

func (m *Session) Reset()

func (*Session) String

func (m *Session) String() string

func (*Session) XXX_DiscardUnknown

func (m *Session) XXX_DiscardUnknown()

func (*Session) XXX_Marshal

func (m *Session) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Session) XXX_Merge

func (dst *Session) XXX_Merge(src proto.Message)

func (*Session) XXX_Size

func (m *Session) XXX_Size() int

func (*Session) XXX_Unmarshal

func (m *Session) XXX_Unmarshal(b []byte) error

type SetDesc

type SetDesc struct {
	DefaultAcs           *DefaultAcsMode `protobuf:"bytes,1,opt,name=default_acs,json=defaultAcs" json:"default_acs,omitempty"`
	Public               []byte          `protobuf:"bytes,2,opt,name=public,proto3" json:"public,omitempty"`
	Private              []byte          `protobuf:"bytes,3,opt,name=private,proto3" json:"private,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

SetDesc: C2S in set.what == "desc" and sub.init message

func (*SetDesc) Descriptor

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

func (*SetDesc) GetDefaultAcs

func (m *SetDesc) GetDefaultAcs() *DefaultAcsMode

func (*SetDesc) GetPrivate

func (m *SetDesc) GetPrivate() []byte

func (*SetDesc) GetPublic

func (m *SetDesc) GetPublic() []byte

func (*SetDesc) ProtoMessage

func (*SetDesc) ProtoMessage()

func (*SetDesc) Reset

func (m *SetDesc) Reset()

func (*SetDesc) String

func (m *SetDesc) String() string

func (*SetDesc) XXX_DiscardUnknown

func (m *SetDesc) XXX_DiscardUnknown()

func (*SetDesc) XXX_Marshal

func (m *SetDesc) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*SetDesc) XXX_Merge

func (dst *SetDesc) XXX_Merge(src proto.Message)

func (*SetDesc) XXX_Size

func (m *SetDesc) XXX_Size() int

func (*SetDesc) XXX_Unmarshal

func (m *SetDesc) XXX_Unmarshal(b []byte) error

type SetQuery

type SetQuery struct {
	// Topic metadata, new topic & new subscriptions only
	Desc *SetDesc `protobuf:"bytes,1,opt,name=desc" json:"desc,omitempty"`
	// Subscription parameters
	Sub *SetSub `protobuf:"bytes,2,opt,name=sub" json:"sub,omitempty"`
	// Indexable tags
	Tags []string `protobuf:"bytes,3,rep,name=tags" json:"tags,omitempty"`
	// Credential being updated.
	Cred                 *ClientCred `protobuf:"bytes,4,opt,name=cred" json:"cred,omitempty"`
	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
	XXX_unrecognized     []byte      `json:"-"`
	XXX_sizecache        int32       `json:"-"`
}

func (*SetQuery) Descriptor

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

func (*SetQuery) GetCred

func (m *SetQuery) GetCred() *ClientCred

func (*SetQuery) GetDesc

func (m *SetQuery) GetDesc() *SetDesc

func (*SetQuery) GetSub

func (m *SetQuery) GetSub() *SetSub

func (*SetQuery) GetTags

func (m *SetQuery) GetTags() []string

func (*SetQuery) ProtoMessage

func (*SetQuery) ProtoMessage()

func (*SetQuery) Reset

func (m *SetQuery) Reset()

func (*SetQuery) String

func (m *SetQuery) String() string

func (*SetQuery) XXX_DiscardUnknown

func (m *SetQuery) XXX_DiscardUnknown()

func (*SetQuery) XXX_Marshal

func (m *SetQuery) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*SetQuery) XXX_Merge

func (dst *SetQuery) XXX_Merge(src proto.Message)

func (*SetQuery) XXX_Size

func (m *SetQuery) XXX_Size() int

func (*SetQuery) XXX_Unmarshal

func (m *SetQuery) XXX_Unmarshal(b []byte) error

type SetSub

type SetSub struct {
	// User affected by this request. Default (empty): current user
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId" json:"user_id,omitempty"`
	// Access mode change, either Given or Want depending on context
	Mode                 string   `protobuf:"bytes,2,opt,name=mode" json:"mode,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

SetSub: payload in set.sub request to update current subscription or invite another user, {sub.what} == "sub"

func (*SetSub) Descriptor

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

func (*SetSub) GetMode

func (m *SetSub) GetMode() string

func (*SetSub) GetUserId

func (m *SetSub) GetUserId() string

func (*SetSub) ProtoMessage

func (*SetSub) ProtoMessage()

func (*SetSub) Reset

func (m *SetSub) Reset()

func (*SetSub) String

func (m *SetSub) String() string

func (*SetSub) XXX_DiscardUnknown

func (m *SetSub) XXX_DiscardUnknown()

func (*SetSub) XXX_Marshal

func (m *SetSub) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*SetSub) XXX_Merge

func (dst *SetSub) XXX_Merge(src proto.Message)

func (*SetSub) XXX_Size

func (m *SetSub) XXX_Size() int

func (*SetSub) XXX_Unmarshal

func (m *SetSub) XXX_Unmarshal(b []byte) error

type SubscriptionEvent

type SubscriptionEvent struct {
	Action               Crud        `protobuf:"varint,1,opt,name=action,enum=pbx.Crud" json:"action,omitempty"`
	Topic                string      `protobuf:"bytes,2,opt,name=topic" json:"topic,omitempty"`
	UserId               string      `protobuf:"bytes,3,opt,name=user_id,json=userId" json:"user_id,omitempty"`
	DelId                int32       `protobuf:"varint,4,opt,name=del_id,json=delId" json:"del_id,omitempty"`
	ReadId               int32       `protobuf:"varint,5,opt,name=read_id,json=readId" json:"read_id,omitempty"`
	RecvId               int32       `protobuf:"varint,6,opt,name=recv_id,json=recvId" json:"recv_id,omitempty"`
	Mode                 *AccessMode `protobuf:"bytes,7,opt,name=mode" json:"mode,omitempty"`
	Private              []byte      `protobuf:"bytes,8,opt,name=private,proto3" json:"private,omitempty"`
	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
	XXX_unrecognized     []byte      `json:"-"`
	XXX_sizecache        int32       `json:"-"`
}

func (*SubscriptionEvent) Descriptor

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

func (*SubscriptionEvent) GetAction

func (m *SubscriptionEvent) GetAction() Crud

func (*SubscriptionEvent) GetDelId

func (m *SubscriptionEvent) GetDelId() int32

func (*SubscriptionEvent) GetMode

func (m *SubscriptionEvent) GetMode() *AccessMode

func (*SubscriptionEvent) GetPrivate

func (m *SubscriptionEvent) GetPrivate() []byte

func (*SubscriptionEvent) GetReadId

func (m *SubscriptionEvent) GetReadId() int32

func (*SubscriptionEvent) GetRecvId

func (m *SubscriptionEvent) GetRecvId() int32

func (*SubscriptionEvent) GetTopic

func (m *SubscriptionEvent) GetTopic() string

func (*SubscriptionEvent) GetUserId

func (m *SubscriptionEvent) GetUserId() string

func (*SubscriptionEvent) ProtoMessage

func (*SubscriptionEvent) ProtoMessage()

func (*SubscriptionEvent) Reset

func (m *SubscriptionEvent) Reset()

func (*SubscriptionEvent) String

func (m *SubscriptionEvent) String() string

func (*SubscriptionEvent) XXX_DiscardUnknown

func (m *SubscriptionEvent) XXX_DiscardUnknown()

func (*SubscriptionEvent) XXX_Marshal

func (m *SubscriptionEvent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*SubscriptionEvent) XXX_Merge

func (dst *SubscriptionEvent) XXX_Merge(src proto.Message)

func (*SubscriptionEvent) XXX_Size

func (m *SubscriptionEvent) XXX_Size() int

func (*SubscriptionEvent) XXX_Unmarshal

func (m *SubscriptionEvent) XXX_Unmarshal(b []byte) error

type TopicDesc

type TopicDesc struct {
	CreatedAt            int64           `protobuf:"varint,1,opt,name=created_at,json=createdAt" json:"created_at,omitempty"`
	UpdatedAt            int64           `protobuf:"varint,2,opt,name=updated_at,json=updatedAt" json:"updated_at,omitempty"`
	TouchedAt            int64           `protobuf:"varint,3,opt,name=touched_at,json=touchedAt" json:"touched_at,omitempty"`
	Defacs               *DefaultAcsMode `protobuf:"bytes,4,opt,name=defacs" json:"defacs,omitempty"`
	Acs                  *AccessMode     `protobuf:"bytes,5,opt,name=acs" json:"acs,omitempty"`
	SeqId                int32           `protobuf:"varint,6,opt,name=seq_id,json=seqId" json:"seq_id,omitempty"`
	ReadId               int32           `protobuf:"varint,7,opt,name=read_id,json=readId" json:"read_id,omitempty"`
	RecvId               int32           `protobuf:"varint,8,opt,name=recv_id,json=recvId" json:"recv_id,omitempty"`
	DelId                int32           `protobuf:"varint,9,opt,name=del_id,json=delId" json:"del_id,omitempty"`
	Public               []byte          `protobuf:"bytes,10,opt,name=public,proto3" json:"public,omitempty"`
	Private              []byte          `protobuf:"bytes,11,opt,name=private,proto3" json:"private,omitempty"`
	State                string          `protobuf:"bytes,12,opt,name=state" json:"state,omitempty"`
	StateAt              int64           `protobuf:"varint,13,opt,name=state_at,json=stateAt" json:"state_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

Topic description, S2C in Meta message

func (*TopicDesc) Descriptor

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

func (*TopicDesc) GetAcs

func (m *TopicDesc) GetAcs() *AccessMode

func (*TopicDesc) GetCreatedAt

func (m *TopicDesc) GetCreatedAt() int64

func (*TopicDesc) GetDefacs

func (m *TopicDesc) GetDefacs() *DefaultAcsMode

func (*TopicDesc) GetDelId

func (m *TopicDesc) GetDelId() int32

func (*TopicDesc) GetPrivate

func (m *TopicDesc) GetPrivate() []byte

func (*TopicDesc) GetPublic

func (m *TopicDesc) GetPublic() []byte

func (*TopicDesc) GetReadId

func (m *TopicDesc) GetReadId() int32

func (*TopicDesc) GetRecvId

func (m *TopicDesc) GetRecvId() int32

func (*TopicDesc) GetSeqId

func (m *TopicDesc) GetSeqId() int32

func (*TopicDesc) GetState

func (m *TopicDesc) GetState() string

func (*TopicDesc) GetStateAt

func (m *TopicDesc) GetStateAt() int64

func (*TopicDesc) GetTouchedAt

func (m *TopicDesc) GetTouchedAt() int64

func (*TopicDesc) GetUpdatedAt

func (m *TopicDesc) GetUpdatedAt() int64

func (*TopicDesc) ProtoMessage

func (*TopicDesc) ProtoMessage()

func (*TopicDesc) Reset

func (m *TopicDesc) Reset()

func (*TopicDesc) String

func (m *TopicDesc) String() string

func (*TopicDesc) XXX_DiscardUnknown

func (m *TopicDesc) XXX_DiscardUnknown()

func (*TopicDesc) XXX_Marshal

func (m *TopicDesc) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TopicDesc) XXX_Merge

func (dst *TopicDesc) XXX_Merge(src proto.Message)

func (*TopicDesc) XXX_Size

func (m *TopicDesc) XXX_Size() int

func (*TopicDesc) XXX_Unmarshal

func (m *TopicDesc) XXX_Unmarshal(b []byte) error

type TopicEvent

type TopicEvent struct {
	Action               Crud       `protobuf:"varint,1,opt,name=action,enum=pbx.Crud" json:"action,omitempty"`
	Name                 string     `protobuf:"bytes,2,opt,name=name" json:"name,omitempty"`
	Desc                 *TopicDesc `protobuf:"bytes,3,opt,name=desc" json:"desc,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

func (*TopicEvent) Descriptor

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

func (*TopicEvent) GetAction

func (m *TopicEvent) GetAction() Crud

func (*TopicEvent) GetDesc

func (m *TopicEvent) GetDesc() *TopicDesc

func (*TopicEvent) GetName

func (m *TopicEvent) GetName() string

func (*TopicEvent) ProtoMessage

func (*TopicEvent) ProtoMessage()

func (*TopicEvent) Reset

func (m *TopicEvent) Reset()

func (*TopicEvent) String

func (m *TopicEvent) String() string

func (*TopicEvent) XXX_DiscardUnknown

func (m *TopicEvent) XXX_DiscardUnknown()

func (*TopicEvent) XXX_Marshal

func (m *TopicEvent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TopicEvent) XXX_Merge

func (dst *TopicEvent) XXX_Merge(src proto.Message)

func (*TopicEvent) XXX_Size

func (m *TopicEvent) XXX_Size() int

func (*TopicEvent) XXX_Unmarshal

func (m *TopicEvent) XXX_Unmarshal(b []byte) error

type TopicSub

type TopicSub struct {
	UpdatedAt int64       `protobuf:"varint,1,opt,name=updated_at,json=updatedAt" json:"updated_at,omitempty"`
	DeletedAt int64       `protobuf:"varint,2,opt,name=deleted_at,json=deletedAt" json:"deleted_at,omitempty"`
	Online    bool        `protobuf:"varint,3,opt,name=online" json:"online,omitempty"`
	Acs       *AccessMode `protobuf:"bytes,4,opt,name=acs" json:"acs,omitempty"`
	ReadId    int32       `protobuf:"varint,5,opt,name=read_id,json=readId" json:"read_id,omitempty"`
	RecvId    int32       `protobuf:"varint,6,opt,name=recv_id,json=recvId" json:"recv_id,omitempty"`
	Public    []byte      `protobuf:"bytes,7,opt,name=public,proto3" json:"public,omitempty"`
	Private   []byte      `protobuf:"bytes,8,opt,name=private,proto3" json:"private,omitempty"`
	// Uid of the subscribed user
	UserId string `protobuf:"bytes,9,opt,name=user_id,json=userId" json:"user_id,omitempty"`
	// Topic name of this subscription
	Topic     string `protobuf:"bytes,10,opt,name=topic" json:"topic,omitempty"`
	TouchedAt int64  `protobuf:"varint,11,opt,name=touched_at,json=touchedAt" json:"touched_at,omitempty"`
	// ID of the last {data} message in a topic
	SeqId int32 `protobuf:"varint,12,opt,name=seq_id,json=seqId" json:"seq_id,omitempty"`
	// Messages are deleted up to this ID
	DelId int32 `protobuf:"varint,13,opt,name=del_id,json=delId" json:"del_id,omitempty"`
	// Other user's last online timestamp & user agent
	LastSeenTime         int64    `protobuf:"varint,14,opt,name=last_seen_time,json=lastSeenTime" json:"last_seen_time,omitempty"`
	LastSeenUserAgent    string   `protobuf:"bytes,15,opt,name=last_seen_user_agent,json=lastSeenUserAgent" json:"last_seen_user_agent,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

MsgTopicSub: topic subscription details, sent in Meta message

func (*TopicSub) Descriptor

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

func (*TopicSub) GetAcs

func (m *TopicSub) GetAcs() *AccessMode

func (*TopicSub) GetDelId

func (m *TopicSub) GetDelId() int32

func (*TopicSub) GetDeletedAt

func (m *TopicSub) GetDeletedAt() int64

func (*TopicSub) GetLastSeenTime

func (m *TopicSub) GetLastSeenTime() int64

func (*TopicSub) GetLastSeenUserAgent

func (m *TopicSub) GetLastSeenUserAgent() string

func (*TopicSub) GetOnline

func (m *TopicSub) GetOnline() bool

func (*TopicSub) GetPrivate

func (m *TopicSub) GetPrivate() []byte

func (*TopicSub) GetPublic

func (m *TopicSub) GetPublic() []byte

func (*TopicSub) GetReadId

func (m *TopicSub) GetReadId() int32

func (*TopicSub) GetRecvId

func (m *TopicSub) GetRecvId() int32

func (*TopicSub) GetSeqId

func (m *TopicSub) GetSeqId() int32

func (*TopicSub) GetTopic

func (m *TopicSub) GetTopic() string

func (*TopicSub) GetTouchedAt

func (m *TopicSub) GetTouchedAt() int64

func (*TopicSub) GetUpdatedAt

func (m *TopicSub) GetUpdatedAt() int64

func (*TopicSub) GetUserId

func (m *TopicSub) GetUserId() string

func (*TopicSub) ProtoMessage

func (*TopicSub) ProtoMessage()

func (*TopicSub) Reset

func (m *TopicSub) Reset()

func (*TopicSub) String

func (m *TopicSub) String() string

func (*TopicSub) XXX_DiscardUnknown

func (m *TopicSub) XXX_DiscardUnknown()

func (*TopicSub) XXX_Marshal

func (m *TopicSub) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TopicSub) XXX_Merge

func (dst *TopicSub) XXX_Merge(src proto.Message)

func (*TopicSub) XXX_Size

func (m *TopicSub) XXX_Size() int

func (*TopicSub) XXX_Unmarshal

func (m *TopicSub) XXX_Unmarshal(b []byte) error

type Unused

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

Dummy placeholder message.

func (*Unused) Descriptor

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

func (*Unused) ProtoMessage

func (*Unused) ProtoMessage()

func (*Unused) Reset

func (m *Unused) Reset()

func (*Unused) String

func (m *Unused) String() string

func (*Unused) XXX_DiscardUnknown

func (m *Unused) XXX_DiscardUnknown()

func (*Unused) XXX_Marshal

func (m *Unused) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Unused) XXX_Merge

func (dst *Unused) XXX_Merge(src proto.Message)

func (*Unused) XXX_Size

func (m *Unused) XXX_Size() int

func (*Unused) XXX_Unmarshal

func (m *Unused) XXX_Unmarshal(b []byte) error

Jump to

Keyboard shortcuts

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