github.com/cloudwan/edgelq-sdk@v1.15.4/proxies/proto/v1/broker_custom.proto

syntax = "proto3";

package ntt.proxies.v1;

import "edgelq-sdk/proxies/proto/v1/project.proto";
import "edgelq-sdk/proxies/proto/v1/project_change.proto";

option go_package = "github.com/cloudwan/edgelq-sdk/proxies/client/v1/broker;broker_client";
option java_multiple_files = false;
option java_outer_classname = "BrokerCustomProto";
option java_package = "com.ntt.proxies.pb.v1";

// Request message for method [Connect][ntt.proxies.v1.Connect]
message ConnectRequest {
  oneof message {
    // The initiation message to open a channel to a device.
    OpenRequest open_request = 1;

    // Attempt to resume stream of data
    ResumeRequest resume_request = 2;

    // ACK message
    Ack ack = 3;

    // Any data sent to the device through the endpoint.
    Data data = 4;

    Close close = 5;

    Error error = 6;

    Ping ping = 7;
  }

  message OpenRequest {
    string project = 1;

    // Region ID to connect to
    string region_id = 6;

    // Service domain (for example devices.edgelq.com) for this provider.
    string service_domain = 7;

    // name to connect to - must match to name value passed in ListenRequest
    string provider_name = 3;

    // Name of the connecting client
    string name = 2;

    // Service to connect
    string service = 4;

    // Initial argument (optional)
    bytes arg = 5;

    // If true, ConnectResponse will contain NotAvailableLocally in response
    // instead of NotFound/OutOfRange. This is used so far internally between
    // servers.
    // TODO: This is temporary flag, till we migrate all clients to shard-aware
    // ones: Client can probe what core endpoint owns given shard number for
    // provider_name. Then it can, and should connect directly there, without
    // setting this flag.
    bool return_not_available = 8;
  }

  message ResumeRequest {
    string project = 1;

    // Region ID to connect to
    string region_id = 7;

    // Service domain (for example devices.edgelq.com) for this provider.
    string service_domain = 8;

    // name to connect to - must match to name value passed in ListenRequest
    string provider_name = 3;

    // Name of the connecting client
    string name = 2;

    uint64 session_id = 4;

    uint64 channel_id = 5;

    uint64 last_message_id = 6;

    // If true, ConnectResponse will contain NotAvailableLocally in response
    // instead of NotFound/OutOfRange. This is used so far internally between
    // servers.
    // TODO: This is temporary flag, till we migrate all clients to shard-aware
    // ones: Client can probe what core endpoint owns given shard number for
    // provider_name. Then it can, and should connect directly there, without
    // setting this flag.
    bool return_not_available = 9;
  }
}

// Response message for method [Connect][ntt.proxies.v1.Connect]
message ConnectResponse {
  oneof message {
    // Notification from the agent (endpoint) to the channel has been opened.
    OpenResponse open_response = 1;

    ResumeResponse resume_response = 2;

    ChannelOpenError channel_open_error = 3;

    // ACK message
    Ack ack = 4;

    // Any data from the device (endpoint) to the client.
    Data data = 5;

    Close close = 6;

    Error error = 7;

    Pong pong = 8;

    // Informs that provider is not available locally.
    // This is sent instead of open_response/resume_response
    // if
    NotAvailableLocally not_available_locally = 9;
  }

  message NotAvailableLocally {}

  message OpenResponse {
    uint64 session_id = 1;

    uint64 channel_id = 2;
  }

  message ResumeResponse {
    uint64 session_id = 1;

    uint64 channel_id = 2;

    uint64 last_message_id = 4;
  }

  message ChannelOpenError {
    // ID of the channel failed to open.
    uint64 channel_id = 1;

    // Error message.
    string message = 2;
  }
}

// Request message for method [Listen][ntt.proxies.v1.Listen]
message ListenRequest {
  oneof message {
    // This is a hello message from the agent with its name.
    OpenRequest open_request = 1;

    ResumeRequest resume_request = 2;

    // When the agent failed to open a requested channel, this message will be
    // sent from the agent to the endpoint.
    ChannelOpenError channel_open_error = 3;

    Ping ping = 4;
  }

  message OpenRequest {
    string project = 1;

    string region_id = 3;

    // Service domain (for example devices.edgelq.com) for this provider.
    string service_domain = 4;

    // The self-declared device name, used for authentication/authorization.
    string name = 2;
  }

  message ResumeRequest {
    string project = 1;

    string region_id = 4;

    // Service domain (for example devices.edgelq.com) for this provider.
    string service_domain = 5;

    // The self-declared device name, used for authentication/authorization.
    string name = 2;

    uint64 session_id = 3;
  }

  message ChannelOpenError {
    // ID of the channel failed to open.
    uint64 channel_id = 1;

    // Error message.
    string message = 2;
  }
}

// Response message for method [Listen][ntt.proxies.v1.Listen]
message ListenResponse {
  oneof message {
    Listening listening = 1;

    // Notifies a new channel has been requested by a client.
    OpenChannelResponse open_channel_response = 2;

    // Notifies a channel was asked to be resumed by a client
    ResumeChannelResponse resume_channel_response = 3;

    Pong pong = 4;
  }

  message Listening { uint64 session_id = 1; }

  message OpenChannelResponse {
    // Channel ID
    uint64 channel_id = 1;

    // Device service;
    string service = 2;

    // Initial argument (optional)
    bytes arg = 3;
  }

  message ResumeChannelResponse {
    // Channel ID
    uint64 channel_id = 1;

    // Device service;
    string service = 2;

    // Initial argument (optional)
    bytes arg = 3;

    uint64 last_message_id = 4;
  }
}

// Request message for method [Accept][ntt.proxies.v1.Accept]
message AcceptRequest {
  oneof message {
    // Registers a new socket on the endpoint.
    OpenRequest open_request = 1;

    ResumeRequest resume_request = 2;

    // Data from the agent to the endpoint (client).
    Data data = 3;

    // ACK message
    Ack ack = 4;

    Close close = 5;

    Error error = 6;

    Ping ping = 7;
  }

  message OpenRequest {
    string project = 1;

    string region_id = 5;

    // Service domain (for example devices.edgelq.com) for this provider.
    string service_domain = 6;

    // Name, to be authenticated/authorized.
    string name = 2;

    uint64 session_id = 3;

    // Channel ID, requested by the endpoint in the ChannelRequested message.
    uint64 channel_id = 4;
  }

  message ResumeRequest {
    string project = 1;

    string region_id = 6;

    // Service domain (for example devices.edgelq.com) for this provider.
    string service_domain = 7;

    // Name, to be authenticated/authorized.
    string name = 2;

    uint64 session_id = 3;

    // Channel ID, requested by the endpoint in the ChannelRequested message.
    uint64 channel_id = 4;

    uint64 last_message_id = 5;
  }
}

// Response message for method [Accept][ntt.proxies.v1.Accept]
message AcceptResponse {
  oneof message {
    // Data from the endpoint (client) to the agent.
    Data data = 1;

    // ACK message
    Ack ack = 2;

    Close close = 3;

    Error error = 4;

    Pong pong = 5;
  }
}

message Ping {}

message Pong {}

message Data {
  uint64 id = 1;

  bytes bytes = 2;

  bool ack_required = 3;
}

message Ack { uint64 id = 1; }

message Close { uint64 id = 1; }

message Error {
  uint64 id = 1;

  string message = 2;
}