github.com/cockroachdb/cockroach@v20.2.0-alpha.1+incompatible/pkg/gossip/doc.go (about)

     1  // Copyright 2014 The Cockroach Authors.
     2  //
     3  // Use of this software is governed by the Business Source License
     4  // included in the file licenses/BSL.txt.
     5  //
     6  // As of the Change Date specified in that file, in accordance with
     7  // the Business Source License, use of this software will be governed
     8  // by the Apache License, Version 2.0, included in the file
     9  // licenses/APL.txt.
    10  
    11  /*
    12  Package gossip implements a protocol for sharing information between
    13  Cockroach nodes using an ad-hoc, peer-to-peer network. The
    14  self-assembled network aims to minimize time for new information to
    15  reach each node, and minimize network traffic required.
    16  
    17  Gossiped information is identified by key. Gossip information is
    18  captured by info objects.
    19  
    20  Single-valued info values can have any type.
    21  
    22  A map of info objects is kept by a Gossip instance. Single-valued info
    23  objects can be added via Gossip.AddInfo(). Info can be queried for
    24  single-valued keys via Gossip.GetInfo.
    25  */
    26  package gossip