Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

getline.c File Reference


Detailed Description

Line-oriented parsing from memory buffer.

Author:
Raphael Manfredi
Date:
2001-2003

#include "common.h"
#include <string.h>
#include "getline.h"
#include "walloc.h"
#include "misc.h"
#include "override.h"

Defines

#define START_LENGTH   512
#define GROW_LENGTH   1024

Functions

 RCSID ("$Id:getline.c, v 1.3 2005/06/25 01:37:42 daichik Exp $")
getline_tgetline_make (gint maxlen)
 Create a new line reading object, capable of holding a line of at most `maxlen' bytes.

void getline_free (getline_t *o)
 Destroy getline object.

void getline_reset (getline_t *o)
 Prepare getline object for a new read cycle by forgetting whatever it currently holds.

gint getline_read (getline_t *o, gchar *data, gint len, gint *used)
 Read line of a header from supplied buffer.

gchar * getline_str (getline_t *o)
gint getline_length (getline_t *o)
void getline_copy (getline_t *source, getline_t *dest)
 Copy source into dest.


Define Documentation

#define GROW_LENGTH   1024
 

#define START_LENGTH   512
 


Function Documentation

void getline_copy getline_t source,
getline_t dest
 

Copy source into dest.

void getline_free getline_t o  ) 
 

Destroy getline object.

gint getline_length getline_t o  ) 
 

Returns:
the length of the currently accumulated line.

getline_t* getline_make gint  maxlen  ) 
 

Create a new line reading object, capable of holding a line of at most `maxlen' bytes.

gint getline_read getline_t o,
gchar *  data,
gint  len,
gint *  used
 

Read line of a header from supplied buffer.

We define a line as being something that ends with either "\r\n" or "\n". Although in the Gnutella world, everything is specified to use "\r\n", we must acknowledge the fact that we have to be liberal. In the UNIX world, lines end by "\n", and most Internet protocols (SMTP, NNTP, HTTP) allow for both endings.

We read from `data', at most `len' bytes. If `used' is non-null, it is filled with the amount of bytes we effectively used, unless an error occurs. When READ_MORE is returned, it is guaranteed that used will be `len'.

The trailing "\r\n" or "\n" is stripped from the accumulated line.

void getline_reset getline_t o  ) 
 

Prepare getline object for a new read cycle by forgetting whatever it currently holds.

gchar* getline_str getline_t o  ) 
 

Returns:
a C string (NUL-terminated) corresponding to the line we currently have in the buffer.

RCSID "$Id:getline.  c,
v 1.3 2005/06/25 01:37:42 daichik Exp $" 
 


Generated on Sun Feb 12 10:50:01 2006 for Gtk-Gnutella by doxygen 1.3.6