# README
Protocol Buffer and gRPC definitions
Definitions for gRPC client and plugins.
gRPC clients must implement rpc service Node
, 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. 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
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Instruct Tinode server to continue with default processing of the client request.
Drop the request as if the client did not send it.
Replace client's original request with the provided request then continue with processing.
Send the the provided response to the client.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
Actual access mode.
No description provided by the author
User creation message {acc}.
ClientDel delete messages or topic.
Query topic state {get}.
Client handshake.
Unsubscribe {leave} request message.
Login {login} message.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ClientNote is a client-generated notification for topic subscribers.
ClientPub is client's request to publish data to topic subscribers {pub}.
No description provided by the author
Update topic state {set}.
Subscription request {sub} message.
No description provided by the author
Topic default access mode.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
{ctrl} message.
{data} message.
{info} message: server-side copy of ClientNote with From added.
{meta} message.
Cumulative message.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
{pres} message.
No description provided by the author
Context message.
SetDesc: C2S in set.what == "desc" and sub.init message.
No description provided by the author
SetSub: payload in set.sub request to update current subscription or invite another user, {sub.what} == "sub".
No description provided by the author
Topic description, S2C in Meta message.
No description provided by the author
MsgTopicSub: topic subscription details, sent in Meta message.
Dummy placeholder message.
# Interfaces
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
What to delete, either "msg" to delete messages (default) or "topic" to delete the topic or "sub" to delete a subscription to topic.
No description provided by the author
No description provided by the author
Plugin response codes.
No description provided by the author
No description provided by the author