Skip to content

Commit

Permalink
Cleanup: Renamed network buffer Reader/Writer constructors
Browse files Browse the repository at this point in the history
  • Loading branch information
skyjake committed Jul 24, 2012
1 parent c5228d2 commit e942c04
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 26 deletions.
18 changes: 0 additions & 18 deletions doomsday/engine/api/doomsday.h
Expand Up @@ -337,24 +337,6 @@ boolean MPE_End(void);
/// @addtogroup network
///@{

/**
* Constructs a new reader. The reader will use the engine's netBuffer
* as the reading buffer. The reader has to be destroyed with Reader_Delete()
* after it is not needed any more.
*
* @todo Rename to Reader_NewWithNetworkBuffer().
*/
Reader* Reader_New(void);

/**
* Constructs a new writer. The writer will use the engine's netBuffer
* as the writing buffer. The writer has to be destroyed with Writer_Delete()
* after it is not needed any more.
*
* @todo Rename to Writer_NewWithNetworkBuffer().
*/
Writer* Writer_New(void);

/**
* Send a packet over the network.
*
Expand Down
15 changes: 13 additions & 2 deletions doomsday/engine/portable/include/net_buf.h
Expand Up @@ -71,8 +71,19 @@ typedef struct netbuffer_s {
extern netbuffer_t netBuffer;
extern boolean allowSending;

Reader* Reader_New(void); // see doomsday.h
Writer* Writer_New(void); // see doomsday.h
/**
* Constructs a new reader. The reader will use the engine's netBuffer
* as the reading buffer. The reader has to be destroyed with Reader_Delete()
* after it is not needed any more.
*/
Reader* Reader_NewWithNetworkBuffer(void);

/**
* Constructs a new writer. The writer will use the engine's netBuffer
* as the writing buffer. The writer has to be destroyed with Writer_Delete()
* after it is not needed any more.
*/
Writer* Writer_NewWithNetworkBuffer(void);

/**
* Functions.
Expand Down
4 changes: 2 additions & 2 deletions doomsday/engine/portable/src/net_buf.c
Expand Up @@ -57,12 +57,12 @@ static size_t numOutBytes;
// Number of bytes sent over the network (compressed).
static size_t numSentBytes;

Reader* Reader_New(void)
Reader* Reader_NewWithNetworkBuffer(void)
{
return Reader_NewWithBuffer((const byte*) netBuffer.msg.data, netBuffer.length);
}

Writer* Writer_New(void)
Writer* Writer_NewWithNetworkBuffer(void)
{
return Writer_NewWithBuffer(netBuffer.msg.data, NETBUFFER_MAXSIZE);
}
Expand Down
4 changes: 2 additions & 2 deletions doomsday/engine/portable/src/net_msg.c
Expand Up @@ -54,7 +54,7 @@ void Msg_Begin(int type)
assert(msgWriter == NULL);

// Allocate a new writer.
msgWriter = Writer_New();
msgWriter = Writer_NewWithNetworkBuffer();
netBuffer.msg.type = type;
}

Expand Down Expand Up @@ -88,7 +88,7 @@ void Msg_BeginRead(void)

// Start reading from the netbuffer.
assert(msgReader == NULL);
msgReader = Reader_New();
msgReader = Reader_NewWithNetworkBuffer();
}

void Msg_EndRead(void)
Expand Down
3 changes: 2 additions & 1 deletion doomsday/libdeng/include/de/reader.h
Expand Up @@ -45,7 +45,8 @@ extern "C" {
struct reader_s; // The reader instance (opaque).

/**
* Reader instance. Constructed with Reader_New() or one of the other constructors.
* Reader instance. Constructed with Reader_NewWithBuffer() or one of the other
* constructors.
*/
typedef struct reader_s Reader;

Expand Down
3 changes: 2 additions & 1 deletion doomsday/libdeng/include/de/writer.h
Expand Up @@ -61,7 +61,8 @@ enum
struct writer_s; // The writer instance (opaque).

/**
* Writer instance. Constructed with Writer_New() or one of the other constructors.
* Writer instance. Constructed with Writer_NewWithBuffer() or one of the other
* constructors.
*/
typedef struct writer_s Writer;

Expand Down

0 comments on commit e942c04

Please sign in to comment.