intervehicle.proto

Go to the documentation of this file.

syntax = "proto2";
import "dccl/option_extensions.proto";
import "goby/protobuf/option_extensions.proto";
import "goby/acomms/protobuf/driver_base.proto";
import "goby/acomms/protobuf/amac_config.proto";
import "goby/acomms/protobuf/buffer.proto";
import "goby/acomms/protobuf/modem_message.proto";
import "goby/middleware/protobuf/intervehicle_transporter_config.proto";
import "goby/middleware/protobuf/serializer_transporter.proto";
 
package goby.middleware.intervehicle.protobuf;
 
message PortalConfig
{
    option (dccl.msg) = {
        unit_system: "si"
    };
 
    message LinkConfig
    {
        required uint32 modem_id = 1;
        optional uint32 subnet_mask = 2 [default = 0xFFF0];
 
        required goby.acomms.protobuf.DriverConfig driver = 11
            [(goby.field).description =
                 "Configure the modem driver(s) in use by this portal"];
 
        optional goby.acomms.protobuf.MACConfig mac = 12
            [(goby.field).description =
                 "Configure the acoustic Medium Access Control"];
 
        optional goby.acomms.protobuf.DynamicBufferConfig subscription_buffer =
            13 [(goby.field).description =
                    "Buffer configuration for subscription forwarding"];
 
        optional double ack_timeout = 20 [
            default = 1.0,
            (goby.field).description =
                "Time to wait before resending the same data (ARQ wait).",
            (dccl.field) = { units { base_dimensions: "T" } }
        ];
 
        optional double modem_report_interval = 21 [
            default = 10.0,
            (goby.field).description = "Time between modem reports",
            (dccl.field) = { units { base_dimensions: "T" } }
        ];
    }
 
    repeated LinkConfig link = 1;
 
    message PersistSubscriptions
    {
        required string name = 1
            [(goby.field).description =
                 "Name to use when persisting subscriptions (must be unique "
                 "for each InterVehiclePortal on this machine)"];
        required string dir = 2
            [(goby.field).description =
                 "Directory to write subscription data file"];
    }
    optional PersistSubscriptions persist_subscriptions = 10
        [(goby.field).description =
             "Configuration for persisting intervehicle subscriptions between "
             "restarts. If omitted, subscriptions will not be persisted, and "
             "all remote subscribers will need to resubscribe when this Portal "
             "restarts."];
}
 
message Status
{
    required int32 tx_queue_size = 1;
}
 
enum SubscriptionDCCLID
{
    SUBSCRIPTION_DCCL_ID__GOBY_3_0 = 2;
    SUBSCRIPTION_DCCL_ID__GOBY_3_1 = 3;
}
 
// when this changes, update GOBY_INTERVEHICLE_API_VERSION in
// goby3/CMakeLists.txt
message Subscription
{
    option (dccl.msg) = {
        codec_version: 3
        id: 3  // SUBSCRIPTION_DCCL_ID__GOBY_3_1
        max_bytes: 32
        unit_system: "si"
    };
 
    // must be first to allow us to decode this field regardless of other
    // message changes so we can warn when its incompatible
    required uint32 api_version = 1
        [(dccl.field) = { min: 1 max: 16 in_head: true }];
 
    required Header header = 2;
    optional uint64 time = 3 [(dccl.field) = {
        omit: true
        units { prefix: "micro" base_dimensions: "T" }
    }];
 
    enum Action
    {
        SUBSCRIBE = 1;
        UNSUBSCRIBE = 2;
    }
    required Action action = 4;
 
    required uint32 dccl_id = 5
        [(dccl.field) = { codec: "dccl.default.id" }];  // 2-byte varint
    required uint32 group = 6
        [(dccl.field) = { min: 0 max: 4294967295 }];  // 4-byte
 
    optional TransporterConfig intervehicle = 10;
    optional goby.middleware.protobuf.SerializerProtobufMetadata metadata = 20
        [(dccl.field).omit = true];
}
 
message Header
{
    required int32 src = 1 [(dccl.field) = { min: 0 max: 65535 }];
    repeated int32 dest = 2
        [(dccl.field) = { min: 0 max: 65535 max_repeat: 4 }];
    optional goby.acomms.protobuf.ModemTransmission modem_msg = 10
        [(dccl.field).omit = true];
}
 
message DCCLPacket
{
    required int32 dccl_id = 1;
    required bytes data = 2;
}
 
// have to split this at the Portal as the Forwarders may not have all the DCCL
// IDs loaded
message DCCLForwardedData
{
    required Header header = 1;
    repeated DCCLPacket frame = 2;
}
 
message AckData
{
    option (dccl.msg) = {
        unit_system: "si"
    };
    required Header header = 1
        [(goby.field).description =
             "src is the modem from which the ack originated. dest is the "
             "local modem that received the ack"];
 
    required int64 latency = 2 [
        (goby.field).description = "Time between queuing and acknowledgement",
        (dccl.field) = { units { prefix: "micro" base_dimensions: "T" } }
    ];
}
 
message ExpireData
{
    option (dccl.msg) = {
        unit_system: "si"
    };
 
    required Header header = 1
        [(goby.field).description =
             "dest is the local modem that expired this message"];
 
    required int64 latency = 2 [
        (goby.field).description = "Time between queuing and expiration",
        (dccl.field) = { units { prefix: "micro" base_dimensions: "T" } }
    ];
 
    enum ExpireReason
    {
        EXPIRED_NO_SUBSCRIBERS = 1;
        EXPIRED_TIME_TO_LIVE_EXCEEDED = 2;
        EXPIRED_BUFFER_OVERFLOW = 3;
    }
    required ExpireReason reason = 3;
 
    // required int32 transmit_attempts = 4
    //    [(goby.field).description =
    //         "the number of times this message was transmitted"];
}
 
message AckMessagePair
{
    required goby.middleware.protobuf.SerializerTransporterMessage serializer =
        1;
    required AckData data = 2;
}
 
message ExpireMessagePair
{
    required goby.middleware.protobuf.SerializerTransporterMessage serializer =
        1;
    required ExpireData data = 2;
}
 
message SubscriptionReport
{
    required uint32 link_modem_id = 1;
    repeated Subscription subscription = 2;
    optional Subscription changed = 3;
}
 
message SubscriptionPersistCollection
{
    option (dccl.msg) = {
        unit_system: "si"
    };
 
    required uint64 time = 1 [(dccl.field) = {
        omit: true
        units { prefix: "micro" base_dimensions: "T" }
    }];
    repeated Subscription subscription = 2;
}
 
message ModemTransmissionWithLinkID
{
    required uint32 link_modem_id = 1;
    required goby.acomms.protobuf.ModemTransmission data = 2;
}
 
message ModemRawWithLinkID
{
    required uint32 link_modem_id = 1;
    required goby.acomms.protobuf.ModemRaw data = 2;
}
 
message ModemReportWithLinkID
{
    required uint32 link_modem_id = 1;
    required goby.acomms.protobuf.ModemReport data = 2;
}