sock_udp: add definitions for asynchronous sock

miri64 · miri64 · commit 8d33aed73e50 · 2019-06-19T15:00:07.000+02:00
diff --git a/sys/include/net/sock/udp.h b/sys/include/net/sock/udp.h
@@ -289,6 +289,20 @@ typedef struct _sock_tl_ep sock_udp_ep_t;   /**< An end point for a UDP sock obj
  */
 typedef struct sock_udp sock_udp_t;
 
+#if SOCK_HAS_ASYNC
+/**
+ * @brief   Event callback for @ref sock_udp_t
+ *
+ * @pre `(sock != NULL)`
+ *
+ * @note    Only applicable with @ref SOCK_HAS_ASYNC defined.
+ *
+ * @param[in] sock  The sock the event happened on
+ * @param[in] event The event
+ */
+typedef void (*sock_udp_cb_t)(sock_udp_t *sock, sock_event_type_t type);
+#endif
+
 /**
  * @brief   Creates a new UDP sock object
  *
@@ -343,6 +357,38 @@ int sock_udp_create(sock_udp_t *sock, const sock_udp_ep_t *local,
  */
 void sock_udp_close(sock_udp_t *sock);
 
+#if SOCK_HAS_ASYNC || defined(DOXYGEN)
+/**
+ * @brief   Gets the asynchronous event context from sock object
+ *
+ * @pre `(sock != NULL)`
+ *
+ * @note    Only available with @ref SOCK_HAS_ASYNC defined.
+ *
+ * @param[in] sock  A UDP sock object.
+ * @param[in] cb    An event callback. May be NULL to unset event callback.
+ */
+void sock_udp_set_cb(sock_udp_t *sock, sock_udp_cb_t cb);
+
+#if SOCK_HAS_ASYNC_CTX || defined(DOXYGEN)
+/**
+ * @brief   Gets the asynchronous
+ *
+ * @pre `(sock != NULL)`
+ *
+ * @note    Only available with @ref SOCK_HAS_ASYNC and @ref SOCK_HAS_ASYNC_CTX
+ *          defined.
+ *
+ * @see @ref SOCK_HAS_ASYNC_CTX
+ *
+ * @param[in] sock  A UDP sock object.
+ *
+ * @return  The asynchronous event context
+ */
+sock_async_ctx_t *sock_udp_get_async_ctx(sock_udp_t *sock);
+#endif /* SOCK_HAS_ASYNC_CTX */
+#endif /* SOCK_HAS_ASYNC */
+
 /**
  * @brief   Gets the local end point of a UDP sock object
  *
