Edit

kc3-lang/libevent/include/event2/buffer_compat.h

Branch :

  • Browse

    Commit

  • Author : Nick Mathewson
    Date : 2009-01-26 17:09:37
    Hash : bdbd5e0e
    Message : For every deprecated function, explain why it is deprecated and what you should call instead. svn:r1052

  • include/event2/buffer_compat.h
  • #ifndef _EVENT2_BUFFER_COMPAT_H_
    #define _EVENT2_BUFFER_COMPAT_H_
    
    /** @file buffer_compat.h
    
    	Obsolete and deprecated versions of the functions in buffer.h: provided
    	only for backward compatibility.
     */
    
    
    /**
       Obsolete alias for evbuffer_readln(buffer, NULL, EOL_STYLE_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().
    
       @param buffer the evbuffer to read from
       @return pointer to a single line, or NULL if an error occurred
    
    */
    char *evbuffer_readline(struct evbuffer *buffer);
    
    /**
      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.
    
      @param buffer the evbuffer to be monitored
      @param cb the callback function to invoke when the evbuffer is modified,
                or NULL to remove all callbacks.
      @param cbarg an argument to be provided to the callback function
     */
    void evbuffer_setcb(struct evbuffer *buffer, evbuffer_cb cb, void *cbarg);
    
    #endif