Categorygithub.com/synerex/synerex_api
modulepackage
0.5.1
Repository: https://github.com/synerex/synerex_api.git
Documentation: pkg.go.dev

# README

synerex_api

Protocol Description for Synerex

Synerex is a demand/supply exchange platform for supporting smart environment.

update history

Since synerex v0.5.0 we add SelectModified{Supply/Demand} Since synerex v0.4.0 we update mbus specification.

Synerex Protocol

4 types of messages. Demand Supply Target Mbus MbusMsg MbusOpt MbusState


Synerex API: rpc NotifyDemand(Demand) returns (Response) {} rpc NotifySupply(Supply) returns (Response) {} rpc ProposeDemand(Demand) returns (Response) {} rpc ProposeSupply(Supply) returns (Response) {} rpc SelectSupply(Target) returns (ConfirmResponse) {} rpc SelectModifiedSupply(Supply) returns (ConfirmResponse) {} rpc SelectDemand(Target) returns (ConfirmResponse) {} rpc SelectModifiedDemand(Demand) returns (ConfirmResponse) {} rpc Confirm(Target) returns (Response){} rpc SubscribeDemand(Channel) returns (stream Demand) {} rpc SubscribeSupply(Channel) returns (stream Supply) {}

Mbus is a selectable message bus for specific members. rpc SubscribeMbus(Mbus) returns (stream MbusMsg) {} rpc SendMsg(MbusMsg) returns (Response){} rpc CloseMbus(Mbus) returns (Response){}

To create new Mbus, we can ask to create new MbusID for Synerex Server (since v0.4.0) rpc CreateMbus(MbsOpt) returns (Mbus){} rpc GetMbusState(Mbus) returns (MBusState){}

# Functions

No description provided by the author
No description provided by the author

# Constants

normal gateway.
.
no need to receive.
No description provided by the author
No description provided by the author
closed mbus.
just created (no subscribers).
no mbus is available with the mbus_id or hidden.
there are some subscribers.
No description provided by the author
mbus id for subscribe.
No description provided by the author
No description provided by the author
target for select/confirm.

# Variables

No description provided by the author
Enum value maps for GatewayType.
Enum value maps for GatewayType.
Enum value maps for MbusOpt_MbusType.
Enum value maps for MbusOpt_MbusType.
Enum value maps for MbusState_MbusStatus.
Enum value maps for MbusState_MbusStatus.
Enum value maps for MsgType.
Enum value maps for MsgType.

# Structs

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
Subscribe from Gateway to SynerexServer.
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
options for creating Mbus from v0.4.0.
message for obtaining mbus state from 0.4.0.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UnimplementedSynerexServer can be embedded to have forward compatible implementations.

# 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
No description provided by the author
No description provided by the author
SynerexClient is the client API for Synerex service.
SynerexServer is the server API for Synerex service.

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author