version 3.0

xcodec/xcodec.h

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2008-2011 Juli Mallett. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+#ifndef	XCODEC_XCODEC_H
+#define	XCODEC_XCODEC_H
+
+////////////////////////////////////////////////////////////////////////////////
+//                                                                            //
+// File:           xcodec.h                                                   //
+// Description:    symbolic constants for the basic xcodec protocol           //
+// Project:        WANProxy XTech                                             //
+// Adapted by:     Andreu Vidal Bramfeld-Software                             //
+// Last modified:  2015-08-31                                                 //
+//                                                                            //
+////////////////////////////////////////////////////////////////////////////////
+
+#define	XCODEC_MAGIC		((uint8_t)0xf1)	/* Magic!  */
+
+/*
+ * Usage:
+ * 	<MAGIC> <OP_ESCAPE>
+ *
+ * Effects:
+ * 	A literal XCODEC_MAGIC appears in the output stream.
+ *
+ */
+#define	XCODEC_OP_ESCAPE	((uint8_t)0x00)
+
+/*
+ * Usage:
+ * 	<MAGIC> <OP_EXTRACT> data[uint8_t x XCODEC_SEGMENT_LENGTH]
+ *
+ * Effects:
+ * 	The `data' is hashed, the hash is associated with the data if possible
+ * 	and the data is inserted into the output stream.
+ *
+ * 	If other data is already known by the hash of `data', error will be
+ * 	indicated from the decoder.
+ *
+ */
+#define	XCODEC_OP_EXTRACT	((uint8_t)0x01)
+
+/*
+ * Usage:
+ * 	<MAGIC> <OP_REF> hash[uint64_t]
+ *
+ * Effects:
+ * 	The data associated with the hash `hash' is looked up and inserted into
+ * 	the output stream if possible.
+ *
+ * 	If the `hash' is not known, an OP_ASK will be sent in response.
+ *
+ */
+#define	XCODEC_OP_REF		((uint8_t)0x02)
+
+#define	XCODEC_SEGMENT_LENGTH	(2048)
+
+#endif /* !XCODEC_XCODEC_H */