interprocess_config.proto

Go to the documentation of this file.

syntax = "proto2";
import "goby/protobuf/option_extensions.proto";
 
package goby.udpm.protobuf;
 
message InterProcessPortalConfig
{
    optional string platform = 1 [
        default = "default_goby_platform",
        (goby.field) = {
            description: "Name for this platform (vehicle name, mooring name, topside name, etc.)"
        }
    ];
 
    optional string listen_address = 2 [
        (goby.field).description = "IPv4 or IPv6 address to listen on",
        default = "0.0.0.0"
    ];
    optional string multicast_address = 3 [
        (goby.field).description =
            "IPv4 or IPv6 address for the multicast network (224.0.0.0/24 or ffx2:/16 for local machine)",
        default = "239.142.0.2"
    ];
 
    optional uint32 multicast_port = 4
        [default = 11144, (goby.field).description = "UDP Port"];
 
    optional uint32 udp_payload_bytes = 5 [
        default = 1472,
        (goby.field).description =
            "Maximum UDP payload size in bytes (MTU - IP/UDP headers). Default 1472 = 1500 - 28.",
        (goby.field).cfg = { action: ADVANCED }
    ];
 
    optional uint32 max_send_rate_bytes_per_second = 6 [
        default = 0,
        (goby.field).description =
            "Maximum transmit rate in bytes per second (0 = unlimited). "
            "For example, set to 12500000 for 100 Mbps.",
        (goby.field).cfg = { action: ADVANCED }
    ];
 
    optional string client_name = 20 [
        (goby.field).description =
            "Unique name for InterProcessPortal. Defaults to app.name",
        (goby.field).cfg = { action: ADVANCED }
    ];
}