agent.proto¶
AgentService¶
watch¶
rpc watch(WatchAgentRequest) WatchAgentResponse
Subscription to monitor changes of the agent. This request stays active until it is cancelled from client side or the server is shut down. Supported events: eos::agent_handler::on_agent_option: Configuration option of the agent has changed.
The events on_initialized and on_agent_enabled are out of rpc scope since they imply on creation and destruction of the RPC server itself.
EosSdk reference: eos::agent_handler (class)
agent_id¶
rpc agent_id(AgentIdRequest) AgentIdResponse
Queries for the unique numeric ID of the given agent.
EosSdk reference: eos::agent_mgr::id
enabled¶
rpc enabled(AgentEnabledRequest) AgentEnabledResponse
Queries whether the agent is enabled or not.
EosSdk reference: eos::agent_mgr::enabled
agent_option¶
rpc agent_option(AgentOptionRequest) AgentOptionResponse
Queries for the configured value of the given agent option.
EosSdk reference: eos:agent_mgr::agent_option
agent_option_exists¶
rpc agent_option_exists(AgentOptionExistsRequest) AgentOptionExistsResponse
Queries whether the given option exists in the configuration or not.
EosSdk reference: eos::agent_mgr::agent_option_exists
agent_options¶
rpc agent_options(AgentOptionsRequest) AgentOptionsResponse
Enumerates all configured agent options.
EosSdk reference: eos::agent::agent_option_iter
status¶
rpc status(AgentStatusRequest) AgentStatusResponse
Queries for the last set value for the given status name.
EosSdk reference: eos::agent::status
statuses¶
rpc statuses(AgentStatusesRequest) AgentStatusesResponse
Enumerates all status values set by this agent.
EosSdk reference: eos::agent::status_iter
status_set¶
rpc status_set(AgentStatusSetRequest) AgentStatusSetResponse
Sets a status value for the given status name.
EosSdk reference: eos::agent_mgr::status_set
bulk_status_set¶
rpc bulk_status_set(AgentBulkStatusSetRequest) AgentBulkStatusSetResponse
Sets multiple status name/value pairs at once for this agent.
EosSdk reference: eos::agent_mgr::status_set
status_del¶
rpc status_del(AgentStatusDelRequest) AgentStatusDelResponse
Deletes the stored agent status for the given status name.
EosSdk reference: eos::agent_mgr::status_del
bulk_status_del¶
rpc bulk_status_del(AgentBulkStatusDelRequest) AgentBulkStatusDelResponse
Deletes multiple statuses at once for each given status name.
EosSdk reference: eos::agent_mgr::status_del
agent_uptime¶
rpc agent_uptime(AgentUptimeRequest) AgentUptimeResponse
Gets the time elapsed since the start of this agent.
EosSdk reference: eos::agent_mgr::agent_uptime
ping¶
rpc ping(AgentPingRequest) AgentPingResponse
Causes EosSdkRpc agent to echo the payload and verify that the SDK thread is also responsive.
This function is specific to RPC and does not match any EOS SDK function.
Messages¶
AgentBulkStatusDelRequest¶
| Name | Value | Description |
|---|---|---|
| requests | repeated AgentStatusDelRequest | Array of AgentStatusDelRequest. |
AgentBulkStatusDelResponse¶
| Name | Value | Description |
|---|---|---|
| processed | uint64 | Number of successfully deleted statuses. |
| status | RpcResponseStatus | Success or error details in case of failure. |
AgentBulkStatusSetRequest¶
| Name | Value | Description |
|---|---|---|
| requests | repeated AgentStatusSetRequest | Array of AgentStatusSetRequest |
AgentBulkStatusSetResponse¶
| Name | Value | Description |
|---|---|---|
| processed | uint64 | Number of successfully deleted statuses. |
| status | RpcResponseStatus | Success or error details in case of failure. |
AgentEnabledRequest¶
Empty message.
AgentEnabledResponse¶
| Name | Value | Description |
|---|---|---|
| enabled | bool | True if the agent is enabled, otherwise False. |
AgentIdRequest¶
| Name | Value | Description |
|---|---|---|
| name | string | The name of the agent to query ID for. |
AgentIdResponse¶
| Name | Value | Description |
|---|---|---|
| id | uint32 | Numeric identifier for the agent. |
AgentOption¶
| Name | Value | Description |
|---|---|---|
| name | string | The name of the option for which the notification is received. |
| value | string | The new option value. |
AgentOptionExistsRequest¶
| Name | Value | Description |
|---|---|---|
| name | string | The name of the agent option to query for. |
AgentOptionExistsResponse¶
| Name | Value | Description |
|---|---|---|
| exists | bool | True if the given option name exists, otherwise False. |
AgentOptionRequest¶
| Name | Value | Description |
|---|---|---|
| name | string | The name of the agent option to query for. |
AgentOptionResponse¶
| Name | Value | Description |
|---|---|---|
| value | string | The value for the given option name. |
AgentOptionsRequest¶
Empty message.
AgentOptionsResponse¶
| Name | Value | Description |
|---|---|---|
| name | string | Configured agent option name. |
AgentPingRequest¶
| Name | Value | Description |
|---|---|---|
| payload | string | A user-defined payload. |
AgentPingResponse¶
| Name | Value | Description |
|---|---|---|
| payload | string | An echo of the request's payload. |
| rpc_ack_timestamp | uint64 | Wall-time timestamp when the request gets acknowledged by the RPC thread expressed in nanoseconds. |
| sdk_ack_timestamp | uint64 | Wall-time timestamp when the request gets acknowledged by the SDK thread, expressed in nanoseconds. |
AgentStatusDelRequest¶
| Name | Value | Description |
|---|---|---|
| name | string |
AgentStatusDelResponse¶
Empty message.
AgentStatusRequest¶
| Name | Value | Description |
|---|---|---|
| name | string | The status name to query for. |
AgentStatusResponse¶
| Name | Value | Description |
|---|---|---|
| value | string | The last set status value. |
AgentStatusSetRequest¶
| Name | Value | Description |
|---|---|---|
| name | string | The status name to set. |
| value | string | The corresponding status value to set. |
AgentStatusSetResponse¶
Empty message.
AgentStatusesRequest¶
Empty message.
AgentStatusesResponse¶
| Name | Value | Description |
|---|---|---|
| name | string | Status value set by this agent. |
AgentUptimeRequest¶
Empty message.
AgentUptimeResponse¶
| Name | Value | Description |
|---|---|---|
| seconds | double | The elapsed time in seconds. |
WatchAgentRequest¶
| Name | Value | Description |
|---|---|---|
| ack | bool | Set to true when an ackowledgment is desired. |
WatchAgentResponse¶
Events are streamed as changes happen.
| Name | Value | Description |
|---|---|---|
| oneof agent_event.option_event | AgentOption | |
| ack | bool | If true, this is not an event and the fields below are invalid. |