aboutsummaryrefslogtreecommitdiffstats
path: root/test/packetdrill/packet_to_string.h
diff options
context:
space:
mode:
Diffstat (limited to 'test/packetdrill/packet_to_string.h')
-rw-r--r--test/packetdrill/packet_to_string.h44
1 files changed, 44 insertions, 0 deletions
diff --git a/test/packetdrill/packet_to_string.h b/test/packetdrill/packet_to_string.h
new file mode 100644
index 0000000..462a4f9
--- /dev/null
+++ b/test/packetdrill/packet_to_string.h
@@ -0,0 +1,44 @@
+/*
+ * Copyright 2013 Google Inc.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ */
+/*
+ * Author: ncardwell@google.com (Neal Cardwell)
+ *
+ * Interface for generating human-readable representations of IP packets.
+ */
+
+#ifndef __PACKET_TO_STRING_H__
+#define __PACKET_TO_STRING_H__
+
+#include "packet.h"
+
+enum dump_format_t {
+ DUMP_SHORT, /* brief format used in scripts */
+ DUMP_FULL, /* add local and remote address and port */
+ DUMP_VERBOSE, /* add hex dump */
+};
+
+/* Returns in *ascii_string a human-readable representation of the
+ * packet 'packet'. Returns STATUS_OK on success; on failure returns
+ * STATUS_ERR and sets error message.
+ */
+extern int packet_to_string(struct packet *packet,
+ enum dump_format_t format,
+ char **ascii_string, char **error);
+
+#endif /* __PACKET_TO_STRING_H__ */