/*
This file is part of GNUnet.
- (C) 2011, Christian Grothoff (and other contributing authors)
+ (C) 2011, 2012 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
* @author Sree Harsha Totakura
*/
-#ifndef GNUNET_STREAM_LIB_H_
-#define GNUNET_STREAM_LIB_H_
+#ifndef GNUNET_STREAM_LIB_H
+#define GNUNET_STREAM_LIB_H
#ifdef __cplusplus
extern "C"
GNUNET_STREAM_SHUTDOWN = 2,
/**
- * A serious error occured while operating of this stream
+ * A serious error occured while operating on this stream
*/
GNUNET_STREAM_SYSERR = 3
};
/**
* Tries to open a stream to the target peer
*
+ * @param cfg configuration to use
* @param target the target peer to which the stream has to be opened
* @param app_port the application port number which uniquely identifies this
* stream
* opened
*/
struct GNUNET_STREAM_Socket *
-GNUNET_STREAM_open (const struct GNUNET_PeerIdentity *target,
+GNUNET_STREAM_open (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ const struct GNUNET_PeerIdentity *target,
GNUNET_MESH_ApplicationType app_port,
GNUNET_STREAM_OpenCallback open_cb,
void *open_cb_cls,
/**
* Listens for stream connections for a specific application ports
*
+ * @param cfg the configuration to use
* @param app_port the application port for which new streams will be accepted
* @param listen_cb this function will be called when a peer tries to establish
* a stream with us
* @return listen socket, NULL for any error
*/
struct GNUNET_STREAM_ListenSocket *
-GNUNET_STREAM_listen (GNUNET_MESH_ApplicationType app_port,
+GNUNET_STREAM_listen (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ GNUNET_MESH_ApplicationType app_port,
GNUNET_STREAM_ListenCallback listen_cb,
void *listen_cb_cls);
/**
* Closes the listen socket
*
- * @param socket the listen socket
+ * @param lsocket the listen socket
*/
void
-GNUNET_STREAM_listen_close (struct GNUNET_STREAM_ListenSocket *socket);
+GNUNET_STREAM_listen_close (struct GNUNET_STREAM_ListenSocket *lsocket);
/**
* Functions of this signature are called whenever writing operations
* on a stream are executed
*
- * @param cls the closure from GNUNET_STREAM_write/read
+ * @param cls the closure from GNUNET_STREAM_write
* @param status the status of the stream at the time this function is called
- * @param size the number of bytes read or written
+ * @param size the number of bytes written
*/
typedef void (*GNUNET_STREAM_CompletionContinuation) (void *cls,
enum GNUNET_STREAM_Status
/**
- * Handle to cancel IO operations.
+ * Handle to cancel IO write operations.
*/
-struct GNUNET_STREAM_IOHandle;
+struct GNUNET_STREAM_IOWriteHandle;
/**
- * Tries to write the given data to the stream
+ * Handle to cancel IO read operations.
+ */
+struct GNUNET_STREAM_IOReadHandle;
+
+/**
+ * Tries to write the given data to the stream. The maximum size of data that
+ * can be written as part of a write operation is (64 * (64000 - sizeof (struct
+ * GNUNET_STREAM_DataMessage))). If size is greater than this it is not an API
+ * violation, however only the said number of maximum bytes will be written.
*
* @param socket the socket representing a stream
* @param data the data buffer from where the data is written into the stream
* @param size the number of bytes to be written from the data buffer
* @param timeout the timeout period
- * @param write_cont the function to call upon writing some bytes into the stream
+ * @param write_cont the function to call upon writing some bytes into the
+ * stream
* @param write_cont_cls the closure
- * @return handle to cancel the operation
+ * @return handle to cancel the operation; NULL if a previous write is pending
*/
-struct GNUNET_STREAM_IOHandle *
+struct GNUNET_STREAM_IOWriteHandle *
GNUNET_STREAM_write (struct GNUNET_STREAM_Socket *socket,
const void *data,
size_t size,
* Functions of this signature are called whenever data is available from the
* stream.
*
- * @param cls the closure from GNUNET_STREAM_write/read
+ * @param cls the closure from GNUNET_STREAM_read
* @param status the status of the stream at the time this function is called
* @param data traffic from the other side
- * @param size the number of bytes available in data read
+ * @param size the number of bytes available in data read; will be 0 on timeout
* @return number of bytes of processed from 'data' (any data remaining should be
* given to the next time the read processor is called).
*/
typedef size_t (*GNUNET_STREAM_DataProcessor) (void *cls,
- enum GNUNET_STREAM_Status status,
- const char *data,
- size_t size);
+ enum GNUNET_STREAM_Status status,
+ const void *data,
+ size_t size);
/**
* @param proc_cls the closure for proc
* @return handle to cancel the operation
*/
-struct GNUNET_STREAM_IOHandle *
-GNUNET_STREAM_read (const struct GNUNET_STREAM_Socket *socket,
+struct GNUNET_STREAM_IOReadHandle *
+GNUNET_STREAM_read (struct GNUNET_STREAM_Socket *socket,
struct GNUNET_TIME_Relative timeout,
GNUNET_STREAM_DataProcessor proc,
void *proc_cls);
/**
- * Cancel pending read or write operation.
+ * Cancels pending write operation. Also cancels packet retransmissions which
+ * may have resulted otherwise.
+ *
+ * CAUTION: Normally a write operation is considered successful if the data
+ * given to it is sent and acknowledged by the receiver. As data is divided
+ * into packets, it is possible that not all packets are received by the
+ * receiver. Any missing packets are then retransmitted till the receiver
+ * acknowledges all packets or until a timeout . During this scenario if the
+ * write operation is cancelled all such retransmissions are also
+ * cancelled. This may leave the receiver's receive buffer incompletely filled
+ * as some missing packets are never retransmitted. So this operation should be
+ * used before shutting down transmission from our side or before closing the
+ * socket.
*
* @param ioh handle to operation to cancel
*/
void
-GNUNET_STREAM_io_cancel (struct GNUNET_STREAM_IOHandle *ioh);
+GNUNET_STREAM_io_write_cancel (struct GNUNET_STREAM_IOWriteHandle *iowh);
+
+
+/**
+ * Cancel pending read operation.
+ *
+ * @param ioh handle to operation to cancel
+ */
+void
+GNUNET_STREAM_io_read_cancel (struct GNUNET_STREAM_IOReadHandle *iorh);
#if 0
}
#endif
-#endif
+#endif /* STREAM_PROTOCOL_H */