| Index: common/logdog/frame/doc.go
|
| diff --git a/common/logdog/frame/doc.go b/common/logdog/frame/doc.go
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..dfa4f015bdb65a1b7dd2e518bd6abd43d39df45f
|
| --- /dev/null
|
| +++ b/common/logdog/frame/doc.go
|
| @@ -0,0 +1,18 @@
|
| +// Copyright 2015 The Chromium Authors. All rights reserved.
|
| +// Use of this source code is governed by a BSD-style license that can be
|
| +// found in the LICENSE file.
|
| +
|
| +// Package frame implements a basic data frame protocol, as well as a reader
|
| +// and writer for the protocol.
|
| +//
|
| +// LogDog uses frames to contain chunks of data (usually serialized protobufs).
|
| +// The frame protocol consists of a series of back-to-back frames containing
|
| +// opaque data types.
|
| +//
|
| +// Each frame begins with a Uvarint (
|
| +// http://golang.org/pkg/encoding/binary/#Uvarint) containing the size of the
|
| +// frame, followed by that many bytes of frame data.
|
| +//
|
| +// The frame protocol does not handle data integrity; that is left to the
|
| +// outer protocol or medium which uses the frame.
|
| +package frame
|
|
|