package rings_node

Get desktop application:
View/edit binary Protocol Buffers messages

Rings node external service

• rpc AnswerOffer (AnswerOfferRequest, AnswerOfferResponse)

  rings_node.proto:199

  Answer offer for manually handshake

• rpc NodeInfo (NodeInfoRequest, NodeInfoResponse)

  rings_node.proto:201

  / Retrieve Node info

• rpc NodeDid (NodeDidRequest, NodeDidResponse)

  rings_node.proto:203

  / Retrieve Node DID

Rings node internal service

• rpc ConnectPeerViaHttp (ConnectPeerViaHttpRequest, ConnectPeerViaHttpResponse)

  rings_node.proto:163

  Connect peer via remote peer's http endpoint

  message ConnectPeerViaHttpRequest

  rings_node.proto:9

  • string url = 1

  message ConnectPeerViaHttpResponse

  rings_node.proto:13

  • string did = 1

• rpc ConnectWithDid (ConnectWithDidRequest, ConnectWithDidResponse)

  rings_node.proto:165

  Connect peer with remote peer's did

  message ConnectWithDidRequest

  rings_node.proto:17

  • string did = 1

  message ConnectWithDidResponse

  rings_node.proto:21

  (message has no fields)

• rpc ConnectWithSeed (ConnectWithSeedRequest, ConnectWithSeedResponse)

  rings_node.proto:167

  Connect peers from a seed file

  message ConnectWithSeedRequest

  rings_node.proto:28

  • repeated SeedPeer peers = 1

  message ConnectWithSeedResponse

  rings_node.proto:32

  (message has no fields)

• rpc ListPeers (ListPeersRequest, ListPeersResponse)

  rings_node.proto:169

  List all connected peers

  message ListPeersRequest

  rings_node.proto:34

  (message has no fields)

  message ListPeersResponse

  rings_node.proto:36

  • repeated PeerInfo peers = 1

• rpc CreateOffer (CreateOfferRequest, CreateOfferResponse)

  rings_node.proto:171

  Create offer for manually handshake

  message CreateOfferRequest

  rings_node.proto:40

  • string did = 1

  message CreateOfferResponse

  rings_node.proto:44

  • string offer = 1

• rpc AnswerOffer (AnswerOfferRequest, AnswerOfferResponse)

  rings_node.proto:173

  Answer offer for manually handshake

• rpc AcceptAnswer (AcceptAnswerRequest, AcceptAnswerResponse)

  rings_node.proto:175

  Accept Answer for manually handshake

  message AcceptAnswerRequest

  rings_node.proto:56

  • string answer = 1

  message AcceptAnswerResponse

  rings_node.proto:60

  (message has no fields)

• rpc Disconnect (DisconnectRequest, DisconnectResponse)

  rings_node.proto:177

  Disconnect a peer

  message DisconnectRequest

  rings_node.proto:62

  • string did = 1

  message DisconnectResponse

  rings_node.proto:66

  (message has no fields)

• rpc SendCustomMessage (SendCustomMessageRequest, SendCustomMessageResponse)

  rings_node.proto:179

  Send custom message to peer

  message SendCustomMessageRequest

  rings_node.proto:68

  • string destination_did = 1

  • string data = 2

  message SendCustomMessageResponse

  rings_node.proto:73

  (message has no fields)

• rpc SendBackendMessage (SendBackendMessageRequest, SendBackendMessageResponse)

  rings_node.proto:181

  Send backend message

  message SendBackendMessageRequest

  rings_node.proto:75

  • string destination_did = 1

  • string data = 2

  message SendBackendMessageResponse

  rings_node.proto:80

  (message has no fields)

• rpc PublishMessageToTopic (PublishMessageToTopicRequest, PublishMessageToTopicResponse)

  rings_node.proto:183

  Append data to topic

  message PublishMessageToTopicRequest

  rings_node.proto:82

  • string topic = 1

  • string data = 2

  message PublishMessageToTopicResponse

  rings_node.proto:87

  (message has no fields)

• rpc FetchTopicMessages (FetchTopicMessagesRequest, FetchTopicMessagesResponse)

  rings_node.proto:185

  Fetch data of topic

  message FetchTopicMessagesRequest

  rings_node.proto:89

  • string topic = 1

  • int64 skip = 2

  message FetchTopicMessagesResponse

  rings_node.proto:94

  • repeated string data = 1

• rpc RegisterService (RegisterServiceRequest, RegisterServiceResponse)

  rings_node.proto:187

  Register service

  message RegisterServiceRequest

  rings_node.proto:98

  • string name = 1

  message RegisterServiceResponse

  rings_node.proto:102

  (message has no fields)

• rpc LookupService (LookupServiceRequest, LookupServiceResponse)

  rings_node.proto:189

  Lookup service

  message LookupServiceRequest

  rings_node.proto:104

  • string name = 1

  message LookupServiceResponse

  rings_node.proto:108

  • repeated string dids = 1

• rpc NodeInfo (NodeInfoRequest, NodeInfoResponse)

  rings_node.proto:191

  Retrieve Node info

• rpc NodeDid (NodeDidRequest, NodeDidResponse)

  rings_node.proto:193

  Retrieve Node DID

Used as request type in: ExternalService.AnswerOffer, InternalService.AnswerOffer

• string offer = 1

Used as response type in: ExternalService.AnswerOffer, InternalService.AnswerOffer

• string answer = 1

Used in: SwarmInfo

• string did = 1

• repeated string successors = 2

• optional string predecessor = 3

• repeated FingerTableRange finger_table_ranges = 4

Used in: DhtInfo

• optional string did = 1

• uint64 start = 2

• uint64 end = 3

Used as request type in: ExternalService.NodeDid, InternalService.NodeDid

(message has no fields)

Used as response type in: ExternalService.NodeDid, InternalService.NodeDid

• string did = 1

Used as request type in: ExternalService.NodeInfo, InternalService.NodeInfo

(message has no fields)

Used as response type in: ExternalService.NodeInfo, InternalService.NodeInfo

• string version = 1

• optional SwarmInfo swarm = 2

Used in: ListPeersResponse, SwarmInfo

• string did = 1

• string state = 2

Used in: ConnectWithSeedRequest

• string did = 1

• string url = 2

Used in: SwarmInfo

• repeated StorageItem items = 1

Used in: StorageInfo

• string key = 1

• optional StorageValue value = 2

Used in: StorageItem

• string did = 1

• string kind = 2

• repeated string data = 3

Used in: NodeInfoResponse

• repeated PeerInfo peers = 1

• optional DhtInfo dht = 2

• optional StorageInfo persistence_storage = 3

• optional StorageInfo cache_storage = 4