Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(26)

Unified Diff: client/logdog/butlerproto/doc.go

Issue 1321273002: LogDog: Add butler protocol reader/write library. (Closed) Base URL: https://github.com/luci/luci-go@logdog-review-frame
Patch Set: Updates. Created 5 years, 1 month ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | client/logdog/butlerproto/proto.go » ('j') | client/logdog/butlerproto/proto.go » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: client/logdog/butlerproto/doc.go
diff --git a/client/logdog/butlerproto/doc.go b/client/logdog/butlerproto/doc.go
new file mode 100644
index 0000000000000000000000000000000000000000..cbcff6291acb8b205f05f58401f5ef6c03bc9eaa
--- /dev/null
+++ b/client/logdog/butlerproto/doc.go
@@ -0,0 +1,29 @@
+// 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 butlerproto implements the LogDog Butler wire protocol. This protocol
+// wraps Butler messages that are published to Cloud Pub/Sub for LogDog
+// consumption.
+//
+// The protocol begins with a set of header bytes to identify and parameterize
+// the remaining data, followed by the data itself.
+//
+// Note that the Pub/Sub layer is assumed to provide both a total length (so no
+// need to length-prefix) and integrity (so no need to checksum).
+//
+// Header
+//
+// The header is a fixed four bytes which positively identify the message as a
+// Butler Pub/Sub message and describe the remaining data. Variant parameters
+// can use different magic numbers to identify different parameters.
+//
+// Two magic numbers are currently defined:
+// - 0x10 0x6d 0x06 0x00 (LogDog protocol ButlerLogBundle Raw)
+// - 0x10 0x6d 0x06 0x62 (LogDog protocol ButlerLogBundle GZip compressed)
+//
+// Data
+//
+// The data component is described by the header, and consists of all data in
+// the Pub/Sub message past the last header byte.
+package butlerproto
« no previous file with comments | « no previous file | client/logdog/butlerproto/proto.go » ('j') | client/logdog/butlerproto/proto.go » ('J')

Powered by Google App Engine
This is Rietveld 408576698