summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/jetpack/vendor/automattic/jetpack-sync/src/interface-codec.php')
-rw-r--r--plugins/jetpack/vendor/automattic/jetpack-sync/src/interface-codec.php44
1 files changed, 44 insertions, 0 deletions
diff --git a/plugins/jetpack/vendor/automattic/jetpack-sync/src/interface-codec.php b/plugins/jetpack/vendor/automattic/jetpack-sync/src/interface-codec.php
new file mode 100644
index 00000000..7653f26d
--- /dev/null
+++ b/plugins/jetpack/vendor/automattic/jetpack-sync/src/interface-codec.php
@@ -0,0 +1,44 @@
+<?php
+/**
+ * Interface for encoding and decoding sync objects.
+ *
+ * @package automattic/jetpack-sync
+ */
+
+namespace Automattic\Jetpack\Sync;
+
+/**
+ * Very simple interface for encoding and decoding input.
+ * This is used to provide compression and serialization to messages.
+ **/
+interface Codec_Interface {
+ /**
+ * Retrieve the name of the codec.
+ * We send this with the payload so we can select the appropriate decoder at the other end.
+ *
+ * @access public
+ *
+ * @return string Name of the codec.
+ */
+ public function name();
+
+ /**
+ * Encode a sync object.
+ *
+ * @access public
+ *
+ * @param mixed $object Sync object to encode.
+ * @return string Encoded sync object.
+ */
+ public function encode( $object );
+
+ /**
+ * Encode a sync object.
+ *
+ * @access public
+ *
+ * @param string $input Encoded sync object to decode.
+ * @return mixed Decoded sync object.
+ */
+ public function decode( $input );
+}