app_base_config.proto

import "goby/common/protobuf/option_extensions.proto";
import "goby/common/protobuf/zero_mq_node_config.proto";
import "goby/common/protobuf/pubsub_node_config.proto";
// import "protobuf/database_request.proto";
import "goby/common/protobuf/logger.proto";

message AppBaseConfig
{
    optional string app_name = 1 [
        (goby.field).example = "myapp_g",
        (goby.field).description =
            "default is compiled name - change this to run multiple instances"
    ];
    // used only by ApplicationBase, ignored by gobyd
    optional float loop_freq = 2 [
        default = 10,
        (goby.field).description = "the frequency (Hz) used to run loop()"
    ];

    optional string platform_name = 3 [
        default = "unnamed_goby_platform",
        (goby.field).description =
            "a unique name for this platform (a platform in this context is a "
            "ship, AUV, workstation, etc.)"
    ];

    optional goby.common.protobuf.PubSubSocketConfig pubsub_config = 10
        [(goby.field).description =
             "configure the connection to the publish / subscribe message "
             "passing architecture"];

    // advanced options
    optional goby.common.protobuf.ZeroMQServiceConfig additional_socket_config =
        100
        [(goby.field).description =
             "open other ZeroMQ sockets, note that `socket_id`s 103998 and "
             "103999 are reserved for the publish / subscribe functionality"];

    optional goby.common.protobuf.GLogConfig glog_config = 11
        [(goby.field).description =
             "configure the Goby Logger (TTY terminal and file debugging "
             "logger)"];

    extensions 1000 to max;

    //  optional goby.common.protobuf.DatabaseClientConfig database_config = 12
    //  [(goby.field).description="configure the Goby Database (SQL Database) to
    //  log the publish/subscribe transactions"];
}