libevent: event2/buffer_compat.h File Reference

libevent 2.1.13 Event notification library

Loading...
Searching...
No Matches
buffer_compat.h File Reference

Obsolete and deprecated versions of the functions in buffer.h: provided only for backward compatibility. More...

`#include <event2/visibility.h>`

Go to the source code of this file.

## Macros
#define | EVBUFFER_DATA(x)
| deprecated in favor of calling the functions directly
#define | EVBUFFER_LENGTH(x)
| deprecated in favor of calling the functions directly

## Typedefs
typedef void(* | evbuffer_cb) (struct evbuffer *buffer, size_t old_len, size_t new_len, void *arg)
| Type definition for a callback that is invoked whenever data is added or removed from an evbuffer.

## Functions
EVENT2_EXPORT_SYMBOL unsigned char * | evbuffer_find (struct evbuffer *buffer, const unsigned char *what, size_t len)
| Find a string within an evbuffer.
EVENT2_EXPORT_SYMBOL char * | evbuffer_readline (struct evbuffer *buffer)
| Obsolete alias for evbuffer_readln(buffer, NULL, EVBUFFER_EOL_ANY).
EVENT2_EXPORT_SYMBOL int | evbuffer_setcb (struct evbuffer *buffer, evbuffer_cb cb, void *cbarg)
| Replace all callbacks on an evbuffer with a single new callback, or remove them.

## Detailed Description

Obsolete and deprecated versions of the functions in buffer.h: provided only for backward compatibility.

## Macro Definition Documentation

## ◆ EVBUFFER_DATA

#define EVBUFFER_DATA | ( |  | x | ) |

Value:
evbuffer_pullup((x), -1)
evbuffer_pullup
EVENT2_EXPORT_SYMBOL unsigned char * evbuffer_pullup(struct evbuffer *buf, ev_ssize_t size)
Makes the data at the beginning of an evbuffer contiguous.

deprecated in favor of calling the functions directly

## ◆ EVBUFFER_LENGTH

#define EVBUFFER_LENGTH | ( |  | x | ) |

Value:
evbuffer_get_length(x)
evbuffer_get_length
EVENT2_EXPORT_SYMBOL size_t evbuffer_get_length(const struct evbuffer *buf)
Returns the total number of bytes stored in the evbuffer.

deprecated in favor of calling the functions directly

## Typedef Documentation

## ◆ evbuffer_cb

typedef void(* evbuffer_cb) (struct evbuffer *buffer, size_t old_len, size_t new_len, void *arg)

Type definition for a callback that is invoked whenever data is added or removed from an evbuffer.

An evbuffer may have one or more callbacks set at a time. The order in which they are executed is undefined.

A callback function may add more callbacks, or remove itself from the list of callbacks, or add or remove data from the buffer. It may not remove another callback from the list.

If a callback adds or removes data from the buffer or from another buffer, this can cause a recursive invocation of your callback or other callbacks. If you ask for an infinite loop, you might just get one: watch out!

Parameters

  buffer | the buffer whose size has changed
  old_len | the previous length of the buffer
  new_len | the current length of the buffer
  arg | a pointer to user data

## Function Documentation

## ◆ evbuffer_find()

EVENT2_EXPORT_SYMBOL unsigned char * evbuffer_find | ( | struct evbuffer * | buffer,
|  | const unsigned char * | what,
|  | size_t | len )

Find a string within an evbuffer.

Parameters

  buffer | the evbuffer to be searched
  what | the string to be searched for
  len | the length of the search string

Returns
  a pointer to the beginning of the search string, or NULL if the search failed.

## ◆ evbuffer_readline()

EVENT2_EXPORT_SYMBOL char * evbuffer_readline | ( | struct evbuffer * | buffer | ) |

Obsolete alias for evbuffer_readln(buffer, NULL, EVBUFFER_EOL_ANY).

Deprecated
  This function is deprecated because its behavior is not correct for almost any protocol, and also because it's wholly subsumed by evbuffer_readln().

Parameters

  buffer | the evbuffer to read from

Returns
  pointer to a single line, or NULL if an error occurred

## ◆ evbuffer_setcb()

EVENT2_EXPORT_SYMBOL int evbuffer_setcb | ( | struct evbuffer * | buffer,
|  | evbuffer_cb | cb,
|  | void * | cbarg )

Replace all callbacks on an evbuffer with a single new callback, or remove them.

Subsequent calls to evbuffer_setcb() replace callbacks set by previous calls. Setting the callback to NULL removes any previously set callback.

Deprecated
  This function is deprecated because it clears all previous callbacks set on the evbuffer, which can cause confusing behavior if multiple parts of the code all want to add their own callbacks on a buffer. Instead, use evbuffer_add(), evbuffer_del(), and evbuffer_setflags() to manage your own evbuffer callbacks without interfering with callbacks set by others.

Parameters

  buffer | the evbuffer to be monitored
  cb | the callback function to invoke when the evbuffer is modified, or NULL to remove all callbacks.
  cbarg | an argument to be provided to the callback function

Returns
  0 if successful, or -1 on error