summaryrefslogtreecommitdiff
path: root/src/rpc/envoy.extensions.upstreams.tcp.v3.rs
blob: f6462af81d02d1148ee39af5d9df0ad2015d948c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
// @generated
// This file is @generated by prost-build.
// \[#protodoc-title: TCP Protocol Options\]
// \[#extension: envoy.upstreams.tcp.tcp_protocol_options\]

// TCProtocolOptions specifies TCP upstream protocol options. This object
// is used in
// :ref:`typed_extension_protocol_options<envoy_v3_api_field_config.cluster.v3.Cluster.typed_extension_protocol_options>`,
// keyed by the name ``envoy.extensions.upstreams.tcp.v3.TcpProtocolOptions``.
//
// .. code::
//
//    clusters:
//      - name: some_service
//        connect_timeout: 5s
//        typed_extension_protocol_options:
//          envoy.extensions.upstreams.tcp.v3.TcpProtocolOptions:
//            "@type": type.googleapis.com/envoy.extensions.upstreams.tcp.v3.TcpProtocolOptions
//            idle_timeout: 10m
//         .... \[further cluster config\]

#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct TcpProtocolOptions {
    /// The idle timeout for the connection. The idle timeout is defined as the period in which
    /// the connection is not associated with a downstream connection. When the idle timeout is
    /// reached, the connection will be closed.
    ///
    /// If not set, the default idle timeout is 10 minutes. To disable idle timeouts, explicitly set this to 0.
    ///
    /// .. warning::
    ///    Disabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP
    ///    FIN packets, etc.
    #[prost(message, optional, tag="1")]
    pub idle_timeout: ::core::option::Option<super::super::super::super::super::google::protobuf::Duration>,
}
// @@protoc_insertion_point(module)