1 /* $NetBSD: buffer_compat.h,v 1.1.1.1 2013/04/11 16:43:34 christos Exp $ */ 2 /* 3 * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. The name of the author may not be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 */ 27 28 #ifndef _EVENT2_BUFFER_COMPAT_H_ 29 #define _EVENT2_BUFFER_COMPAT_H_ 30 31 /** @file event2/buffer_compat.h 32 33 Obsolete and deprecated versions of the functions in buffer.h: provided 34 only for backward compatibility. 35 */ 36 37 38 /** 39 Obsolete alias for evbuffer_readln(buffer, NULL, EOL_STYLE_ANY). 40 41 @deprecated This function is deprecated because its behavior is not correct 42 for almost any protocol, and also because it's wholly subsumed by 43 evbuffer_readln(). 44 45 @param buffer the evbuffer to read from 46 @return pointer to a single line, or NULL if an error occurred 47 48 */ 49 char *evbuffer_readline(struct evbuffer *buffer); 50 51 /** Type definition for a callback that is invoked whenever data is added or 52 removed from an evbuffer. 53 54 An evbuffer may have one or more callbacks set at a time. The order 55 in which they are executed is undefined. 56 57 A callback function may add more callbacks, or remove itself from the 58 list of callbacks, or add or remove data from the buffer. It may not 59 remove another callback from the list. 60 61 If a callback adds or removes data from the buffer or from another 62 buffer, this can cause a recursive invocation of your callback or 63 other callbacks. If you ask for an infinite loop, you might just get 64 one: watch out! 65 66 @param buffer the buffer whose size has changed 67 @param old_len the previous length of the buffer 68 @param new_len the current length of the buffer 69 @param arg a pointer to user data 70 */ 71 typedef void (*evbuffer_cb)(struct evbuffer *buffer, size_t old_len, size_t new_len, void *arg); 72 73 /** 74 Replace all callbacks on an evbuffer with a single new callback, or 75 remove them. 76 77 Subsequent calls to evbuffer_setcb() replace callbacks set by previous 78 calls. Setting the callback to NULL removes any previously set callback. 79 80 @deprecated This function is deprecated because it clears all previous 81 callbacks set on the evbuffer, which can cause confusing behavior if 82 multiple parts of the code all want to add their own callbacks on a 83 buffer. Instead, use evbuffer_add(), evbuffer_del(), and 84 evbuffer_setflags() to manage your own evbuffer callbacks without 85 interfering with callbacks set by others. 86 87 @param buffer the evbuffer to be monitored 88 @param cb the callback function to invoke when the evbuffer is modified, 89 or NULL to remove all callbacks. 90 @param cbarg an argument to be provided to the callback function 91 */ 92 void evbuffer_setcb(struct evbuffer *buffer, evbuffer_cb cb, void *cbarg); 93 94 95 /** 96 Find a string within an evbuffer. 97 98 @param buffer the evbuffer to be searched 99 @param what the string to be searched for 100 @param len the length of the search string 101 @return a pointer to the beginning of the search string, or NULL if the search failed. 102 */ 103 unsigned char *evbuffer_find(struct evbuffer *buffer, const unsigned char *what, size_t len); 104 105 /** deprecated in favor of calling the functions directly */ 106 #define EVBUFFER_LENGTH(x) evbuffer_get_length(x) 107 /** deprecated in favor of calling the functions directly */ 108 #define EVBUFFER_DATA(x) evbuffer_pullup((x), -1) 109 110 #endif 111 112