X-Git-Url: http://git.silcnet.org/gitweb/?p=silc.git;a=blobdiff_plain;f=lib%2Fsilccore%2Fsilcpacket.h;h=0caf10d8c21bc8b54c245e3311265b8b785e6e9a;hp=7ddabff11732bfbfc7b7c6fe856756738b1847f7;hb=1cc9af890006b0181913d4f84909442744476745;hpb=4ad81546bc7519f1022850ac8561d365e0a60b20 diff --git a/lib/silccore/silcpacket.h b/lib/silccore/silcpacket.h index 7ddabff1..0caf10d8 100644 --- a/lib/silccore/silcpacket.h +++ b/lib/silccore/silcpacket.h @@ -17,7 +17,7 @@ */ -/****h* silccore/Packet Protocol Interface +/****h* silccore/SILC Packet Engine Interface * * DESCRIPTION * @@ -34,8 +34,6 @@ #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 @@ -114,9 +112,10 @@ typedef SilcUInt8 SilcPacketFlags; #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 @@ -197,6 +196,9 @@ typedef struct SilcPacketStruct { * 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 { @@ -309,11 +311,11 @@ typedef void (*SilcPacketErrorCb)(SilcPacketEngine engine, void *callback_context, void *stream_context); -/****s* silccore/SilcPacketAPI/SilcPacketStream +/****s* silccore/SilcPacketAPI/SilcPacketCallbacks * * NAME * - * typedef struct SilcPacketStreamStruct *SilcPacketStream; + * typedef struct { ... } *SilcPacketCallbacks; * * DESCRIPTION * @@ -359,7 +361,7 @@ typedef struct { ***/ SilcPacketEngine silc_packet_engine_start(SilcRng rng, SilcBool router, - SilcPacketCallbacks *callbacks, + const SilcPacketCallbacks *callbacks, void *callback_context); /****f* silccore/SilcPacketAPI/silc_packet_engine_stop @@ -376,6 +378,52 @@ silc_packet_engine_start(SilcRng rng, SilcBool router, ***/ 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 @@ -473,6 +521,20 @@ SilcPacketStream silc_packet_stream_add_remote(SilcPacketStream stream, ***/ 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 @@ -589,7 +651,7 @@ SilcStream silc_packet_stream_get_stream(SilcPacketStream stream); * ***/ SilcBool silc_packet_stream_link(SilcPacketStream stream, - SilcPacketCallbacks *callbacks, + const SilcPacketCallbacks *callbacks, void *callback_context, int priority, ...); @@ -609,9 +671,39 @@ SilcBool silc_packet_stream_link(SilcPacketStream stream, * ***/ 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 @@ -619,7 +711,9 @@ void silc_packet_stream_unlink(SilcPacketStream stream, * SilcStream silc_packet_stream_wrap(SilcPacketStream stream, * SilcPacketType type, * SilcPacketFlags flags, - * SilcBool blocking_mode); + * SilcBool blocking_mode, + * SilcPacketWrapCoder coder, + * void *context); * * DESCRIPTION * @@ -644,6 +738,12 @@ void silc_packet_stream_unlink(SilcPacketStream stream, * 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 * NULL on error. @@ -652,9 +752,11 @@ void silc_packet_stream_unlink(SilcPacketStream stream, SilcStream silc_packet_stream_wrap(SilcPacketStream stream, SilcPacketType type, SilcPacketFlags flags, - SilcBool blocking_mode); + SilcBool blocking_mode, + SilcPacketWrapCoder coder, + void *context); -/****f* silccore/SilcPacketAPI/silc_packet_get_sender +/****f* silccore/SilcPacketAPI/silc_packet_stream_is_udp * * SYNOPSIS * @@ -818,7 +920,7 @@ SilcBool silc_packet_get_keys(SilcPacketStream stream, * * 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. @@ -830,6 +932,25 @@ SilcBool silc_packet_set_ids(SilcPacketStream stream, 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 @@ -961,23 +1082,30 @@ SilcBool silc_packet_send_va_ext(SilcPacketStream stream, 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 * @@ -989,14 +1117,14 @@ SilcBool silc_packet_send_va_ext(SilcPacketStream stream, * 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 *