*/
-/****h* silccore/Packet Protocol Interface
+/****h* silccore/SILC Packet Engine Interface
*
* DESCRIPTION
*
#ifndef SILCPACKET_H
#define SILCPACKET_H
-/* XXX many of these could go to silcpacket_i.h */
-
/* Maximum packet length */
#define SILC_PACKET_MAX_LEN 0xffff
#define SILC_PACKET_FLAG_LIST 0x02 /* Packet is a list */
#define SILC_PACKET_FLAG_BROADCAST 0x04 /* Packet is a broadcast */
#define SILC_PACKET_FLAG_COMPRESSED 0x08 /* Payload is compressed */
+#define SILC_PACKET_FLAG_ACK 0x10 /* Acknowledge packet */
/* Impelemntation specific flags */
-#define SILC_PACKET_FLAG_LONG_PAD 0x10 /* Use maximum padding */
+#define SILC_PACKET_FLAG_LONG_PAD 0x20 /* Use maximum padding */
/***/
/****s* silccore/SilcPacketAPI/SilcPacketEngine
* from the actual stream. It can retrieve the underlaying stream from
* the packet stream by calling silc_packet_stream_get_stream function.
*
+ * You may retrieve string version of the SilcPacketError by calling
+ * silc_packet_error_string.
+ *
* SOURCE
*/
typedef enum {
void *callback_context,
void *stream_context);
-/****s* silccore/SilcPacketAPI/SilcPacketStream
+/****s* silccore/SilcPacketAPI/SilcPacketCallbacks
*
* NAME
*
- * typedef struct SilcPacketStreamStruct *SilcPacketStream;
+ * typedef struct { ... } *SilcPacketCallbacks;
*
* DESCRIPTION
*
***/
SilcPacketEngine
silc_packet_engine_start(SilcRng rng, SilcBool router,
- SilcPacketCallbacks *callbacks,
+ const SilcPacketCallbacks *callbacks,
void *callback_context);
/****f* silccore/SilcPacketAPI/silc_packet_engine_stop
***/
void silc_packet_engine_stop(SilcPacketEngine engine);
+/****f* silccore/SilcPacketAPI/silc_packet_error_string
+ *
+ * SYNOPSIS
+ *
+ * const char *silc_packet_error_string(SilcPacketError error);
+ *
+ * DESCRIPTION
+ *
+ * Return the packet error as string.
+ *
+ ***/
+const char *silc_packet_error_string(SilcPacketError error);
+
+/****f* silccore/SilcPacketAPI/silc_packet_engine_get_streams
+ *
+ * SYNOPSIS
+ *
+ * SilcDList silc_packet_engine_get_streams(SilcPacketEngine engine);
+ *
+ * DESCRIPTION
+ *
+ * Returns list of packet streams added to the packet engine. The caller
+ * must free the list with silc_packet_engine_free_streams_list.
+ *
+ * NOTES
+ *
+ * This function may also return disconnected and destroyed streams. The
+ * caller should use silc_packet_stream_is_valid to check if the stream
+ * is valid.
+ *
+ ***/
+SilcDList silc_packet_engine_get_streams(SilcPacketEngine engine);
+
+/****f* silccore/SilcPacketAPI/silc_packet_engine_free_streams_list
+ *
+ * SYNOPSIS
+ *
+ * void silc_packet_engine_free_streams_list(SilcDList streams);
+ *
+ * DESCRIPTION
+ *
+ * Free's the streams list returned by silc_packet_engine_get_streams.
+ *
+ ***/
+void silc_packet_engine_free_streams_list(SilcDList streams);
+
/****f* silccore/SilcPacketAPI/silc_packet_stream_create
*
* SYNOPSIS
***/
void silc_packet_stream_destroy(SilcPacketStream stream);
+/****f* silccore/SilcPacketAPI/silc_packet_stream_is_valid
+ *
+ * SYNOPSIS
+ *
+ * SilcBool silc_packet_stream_is_valid(SilcPacketStream stream);
+ *
+ * DESCRIPTION
+ *
+ * Returns TRUE if the packet stream indicated by `stream' is valid and
+ * has not been disconnected or destroyed.
+ *
+ ***/
+SilcBool silc_packet_stream_is_valid(SilcPacketStream stream);
+
/****f* silccore/SilcPacketAPI/silc_packet_stream_set_router
*
* SYNOPSIS
*
***/
SilcBool silc_packet_stream_link(SilcPacketStream stream,
- SilcPacketCallbacks *callbacks,
+ const SilcPacketCallbacks *callbacks,
void *callback_context,
int priority, ...);
*
***/
void silc_packet_stream_unlink(SilcPacketStream stream,
- SilcPacketCallbacks *callbacks,
+ const SilcPacketCallbacks *callbacks,
void *callback_context);
+/****f* silccore/SilcPacketAPI/SilcPacketWrapCoder
+ *
+ * SYNOPSIS
+ *
+ * typedef SilcBool (*SilcPacketWrapCoder)(SilcStream stream,
+ * SilcStreamStatus status,
+ * SilcBuffer buffer,
+ * void *context);
+ *
+ * DESCRIPTION
+ *
+ * The encoder/decoder callback for silc_packet_stream_wrap. If the
+ * `status' is SILC_STREAM_CAN_WRITE then additional data can be added
+ * to `buffer'. It is added before the data that is written with
+ * silc_stream_write. The silc_buffer_enlarge should be called to verify
+ * there is enough room in `buffer' before adding data to it. The `buffer'
+ * must not be freed.
+ *
+ * If the `status' is SILC_STREAM_CAN_READ then data from the `buffer'
+ * may be read before it is passed to readed when silc_stream_read is
+ * called. The `buffer' may be advanced also to hide data in it.
+ *
+ * This function returns FALSE in case of error.
+ *
+ ***/
+typedef SilcBool (*SilcPacketWrapCoder)(SilcStream stream,
+ SilcStreamStatus status,
+ SilcBuffer buffer,
+ void *context);
+
/****f* silccore/SilcPacketAPI/silc_packet_stream_wrap
*
* SYNOPSIS
*
* SilcStream silc_packet_stream_wrap(SilcPacketStream stream,
* SilcPacketType type,
- * SilcPacketFlags flags);
+ * SilcPacketFlags flags,
+ * SilcBool blocking_mode,
+ * SilcPacketWrapCoder coder,
+ * void *context);
*
* DESCRIPTION
*
* stream can be destroyed by calling silc_stream_destroy. It does not
* destroy the wrapped packet stream.
*
- * The silc_stream_set_notifier must be called before the returned stream
- * can be used to receive packets. The SILC_STREAM_CAN_READ will be
- * returned to the notifier callback to indicate that a packet is ready
- * for reading. Calling silc_stream_read once returns one complete SILC
- * packet data payload (which is of type of `type').
+ * If the `blocking_mode' mode is TRUE then the silc_stream_read and
+ * silc_stream_write may block the calling process or thread until SILC
+ * packet is read or written. If it is FALSE the stream is in non-blocking
+ * mode and the calls never block. The returned stream is thread-safe and
+ * packets may be read and written in multi-threaded environment.
+ *
+ * In non-blocking mode the silc_stream_set_notifier must be called before
+ * the returned stream can be used to read packets. The stream status
+ * SILC_STREAM_CAN_READ will be returned to the notifier callback to
+ * indicate that a packet is ready for reading. Calling silc_stream_read
+ * once returns one complete SILC packet data payload (which is of type of
+ * `type').
+ *
+ * The `coder' is optional encoder/decoder callback which the packet engine
+ * will call if it is non-NULL. It can be used to encode additional data
+ * into each packet when silc_stream_write is called or decode data before
+ * it is passed to reader when silc_stream_read is called. The `context'
+ * is passed to `coder'.
*
* The returned SilcStream can be used as any normal stream and all
* SilcStream API functions may be used with the stream. This returns
***/
SilcStream silc_packet_stream_wrap(SilcPacketStream stream,
SilcPacketType type,
- SilcPacketFlags flags);
+ SilcPacketFlags flags,
+ SilcBool blocking_mode,
+ SilcPacketWrapCoder coder,
+ void *context);
-/****f* silccore/SilcPacketAPI/silc_packet_get_sender
+/****f* silccore/SilcPacketAPI/silc_packet_stream_is_udp
*
* SYNOPSIS
*
*
* DESCRIPTION
*
- * Set the source ID and destinaion ID to be used when sending packets to
+ * Set the source ID and destination ID to be used when sending packets to
* this packet stream. The IDs to be used for a packet stream can be
* overridden when sending packets. However, if the IDs do not ever change
* for the packet stream it is recommended they are set using this function.
SilcIdType src_id_type, const void *src_id,
SilcIdType dst_id_type, const void *dst_id);
+/****f* silccore/SilcPacketAPI/silc_packet_get_ids
+ *
+ * SYNOPSIS
+ *
+ * SilcBool silc_packet_get_ids(SilcPacketStream stream,
+ * SilcBool *src_id_set, SilcID *src_id,
+ * SilcBool *dst_id_set, SilcID *dst_id);
+ *
+ * DESCRIPTION
+ *
+ * Returns source and destination IDs from the packet stream. The
+ * `src_id_set' is set to TRUE if the source ID was returned. The
+ * `dst_id_set' is set to TRUE if the destination ID was returned.
+ *
+ ***/
+SilcBool silc_packet_get_ids(SilcPacketStream stream,
+ SilcBool *src_id_set, SilcID *src_id,
+ SilcBool *dst_id_set, SilcID *dst_id);
+
/****f* silccore/SilcPacketAPI/silc_packet_set_sid
*
* SYNOPSIS
SilcIdType dst_id_type, void *dst_id,
SilcCipher cipher, SilcHmac hmac, ...);
-/****f* silccore/SilcPacketAPI/silc_packet_wait
+/****f* silccore/SilcPacketAPI/silc_packet_wait_init
*
* SYNOPSIS
*
- * void *silc_packet_wait_init(SilcPacketStream stream, ...);
+ * void *silc_packet_wait_init(SilcPacketStream stream,
+ * const SilcID *source_id, ...);
*
* DESCRIPTION
*
* Initializes a packet waiter for the packet stream `stream' and
* for the variable argument list of packet types. The function
* silc_packet_wait can be used to block the thread until a packet
- * has been received. This function is used to initialize the waiting
- * and to give the list of packet types that caller wish to receive.
- * The variable argument list must end with -1. To receive all
- * packets use SILC_PACKET_ANY. Returns a context that must be given
- * to the silc_packet_wait function as argument. Returns NULL on
- * error. To uninitialize the waiting call silc_packet_wait_uninit.
+ * has been received.
+ *
+ * This function is used to initialize the waiting and to give the list
+ * of packet types that caller wish to receive. The variable argument
+ * list must end with -1. To receive all packets use SILC_PACKET_ANY.
+ * If the `source_id' is non-NULL then only packets of the specified
+ * type from the specified `source_id' are received. If it is NULL
+ * then the packet source is ignored.
+ *
+ * Returns a context that must be given to the silc_packet_wait function
+ * as argument. Returns NULL on error. To uninitialize the waiting
+ * call silc_packet_wait_uninit.
*
* NOTES
*
* void *waiter;
*
* // Will wait for private message packets
- * waiter = silc_packet_wait_init(stream,
+ * waiter = silc_packet_wait_init(stream, NULL,
* SILC_PACKET_PRIVATE_MESSAGE, -1);
*
- *
***/
-void *silc_packet_wait_init(SilcPacketStream stream, ...);
+void *silc_packet_wait_init(SilcPacketStream stream,
+ const SilcID *source_id, ...);
-/****f* silccore/SilcPacketAPI/silc_packet_wait
+/****f* silccore/SilcPacketAPI/silc_packet_wait_uninit
*
* SYNOPSIS
*
projects / silc.git / blobdiff