A significantly simpler API for sending UDP packets

2011-08-29 21:30:21 +02:00 · 2011-08-29 21:30:21 +02:00 · 7ce313eef6
commit 7ce313eef6
parent 4fee1513ff
2 changed files with 306 additions and 0 deletions
--- a/core/net/simple-udp.h
+++ b/core/net/simple-udp.h
@ -0,0 +1,94 @@
+/**
+ * \addtogroup uip
+ * @{
+ */
+
+
+/**
+ * \defgroup simple-udp
+ *
+ * The default Contiki UDP API is difficult to use. The simple-udp
+ * module provides a significantly simpler API.
+ *
+ * @{
+ */
+
+/*
+ * Copyright (c) 2011, Swedish Institute of Computer Science.
+ * 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.
+ * 3. Neither the name of the Institute nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE 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 THE INSTITUTE 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.
+ *
+ * This file is part of the Contiki operating system.
+ *
+ * \file
+ *         Header file for the simple-udp module.
+ * \author
+ *         Adam Dunkels <adam@sics.se>
+ *
+ */
+
+#ifndef SIMPLE_UDP_H
+#define SIMPLE_UDP_H
+
+#include "net/uip.h"
+
+struct simple_udp_connection;
+
+typedef void (* simple_udp_callback)(struct simple_udp_connection *c,
+                                     const uip_ipaddr_t *source_addr,
+                                     uint16_t source_port,
+                                     const uip_ipaddr_t *dest_addr,
+                                     uint16_t dest_port,
+                                     const uint8_t *data, uint16_t datalen);
+
+struct simple_udp_connection {
+  struct simple_udp_connection *next;
+  uip_ipaddr_t remote_addr;
+  uint16_t remote_port, local_port;
+  simple_udp_callback receive_callback;
+  struct uip_udp_conn *udp_conn;
+  struct process *client_process;
+};
+
+int simple_udp_register(struct simple_udp_connection *c,
+                        uint16_t local_port,
+                        uip_ipaddr_t *remote_addr,
+                        uint16_t remote_port,
+                        simple_udp_callback receive_callback);
+
+int simple_udp_send(struct simple_udp_connection *c,
+                    const void *data, uint16_t datalen);
+
+int simple_udp_sendto(struct simple_udp_connection *c,
+                      const void *data, uint16_t datalen,
+                      const uip_ipaddr_t *to);
+
+void simple_udp_init(void);
+
+#endif /* SIMPLE_UDP_H */
+
+/** @} */
+/** @} */