src/google/protobuf/package_info.h

   1 // Protocol Buffers - Google's data interchange format
   2 // Copyright 2008 Google Inc.  All rights reserved.
   3 // https://developers.google.com/protocol-buffers/
   4 //
   5 // Redistribution and use in source and binary forms, with or without
   6 // modification, are permitted provided that the following conditions are
   7 // met:
   8 //
   9 //     * Redistributions of source code must retain the above copyright
  10 // notice, this list of conditions and the following disclaimer.
  11 //     * Redistributions in binary form must reproduce the above
  12 // copyright notice, this list of conditions and the following disclaimer
  13 // in the documentation and/or other materials provided with the
  14 // distribution.
  15 //     * Neither the name of Google Inc. nor the names of its
  16 // contributors may be used to endorse or promote products derived from
  17 // this software without specific prior written permission.
  18 //
  19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30
  31 // Author: kenton@google.com (Kenton Varda)
  32 //  Based on original Protocol Buffers design by
  33 //  Sanjay Ghemawat, Jeff Dean, and others.
  34 //
  35 // This file exists solely to document the google::protobuf namespace.
  36 // It is not compiled into anything, but it may be read by an automated
  37 // documentation generator.
  38
  39 namespace google {
  40
  41 // Core components of the Protocol Buffers runtime library.
  42 //
  43 // The files in this package represent the core of the Protocol Buffer
  44 // system.  All of them are part of the libprotobuf library.
  45 //
  46 // A note on thread-safety:
  47 //
  48 // Thread-safety in the Protocol Buffer library follows a simple rule:
  49 // unless explicitly noted otherwise, it is always safe to use an object
  50 // from multiple threads simultaneously as long as the object is declared
  51 // const in all threads (or, it is only used in ways that would be allowed
  52 // if it were declared const).  However, if an object is accessed in one
  53 // thread in a way that would not be allowed if it were const, then it is
  54 // not safe to access that object in any other thread simultaneously.
  55 //
  56 // Put simply, read-only access to an object can happen in multiple threads
  57 // simultaneously, but write access can only happen in a single thread at
  58 // a time.
  59 //
  60 // The implementation does contain some "const" methods which actually modify
  61 // the object behind the scenes -- e.g., to cache results -- but in these cases
  62 // mutex locking is used to make the access thread-safe.
  63 namespace protobuf {}
  64 }  // namespace google