]> git.proxmox.com Git - mirror_frr.git/blobdiff - lib/buffer.h
zebra, lib: fix the ZEBRA_INTERFACE_VRF_UPDATE zapi message
[mirror_frr.git] / lib / buffer.h
index 059f2cf3388db2aad3bc908a7e341f2a84e8761b..0c945a2acfea3fbea58ff97fabea08174d29fd72 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Buffering to output and input. 
+ * Buffering to output and input.
  * Copyright (C) 1998 Kunihiro Ishiguro
  *
  * This file is part of GNU Zebra.
 #ifndef _ZEBRA_BUFFER_H
 #define _ZEBRA_BUFFER_H
 
-
 /* Create a new buffer.  Memory will be allocated in chunks of the given
    size.  If the argument is 0, the library will supply a reasonable
    default size suitable for buffering socket I/O. */
-extern struct buffer *buffer_new (size_t);
+extern struct buffer *buffer_new(size_t);
 
 /* Free all data in the buffer. */
-extern void buffer_reset (struct buffer *);
+extern void buffer_reset(struct buffer *);
 
 /* This function first calls buffer_reset to release all buffered data.
    Then it frees the struct buffer itself. */
-extern void buffer_free (struct buffer *);
+extern void buffer_free(struct buffer *);
 
 /* Add the given data to the end of the buffer. */
-extern void buffer_put (struct buffer *, const void *, size_t);
+extern void buffer_put(struct buffer *, const void *, size_t);
 /* Add a single character to the end of the buffer. */
-extern void buffer_putc (struct buffer *, u_char);
+extern void buffer_putc(struct buffer *, uint8_t);
 /* Add a NUL-terminated string to the end of the buffer. */
-extern void buffer_putstr (struct buffer *, const char *);
+extern void buffer_putstr(struct buffer *, const char *);
 /* Add given data, inline-expanding \n to \r\n */
 extern void buffer_put_crlf(struct buffer *b, const void *p, size_t size);
 
@@ -48,33 +47,33 @@ extern void buffer_put_crlf(struct buffer *b, const void *p, size_t size);
    single NUL-terminated string allocated using XMALLOC(MTYPE_TMP).  Note
    that this function does not alter the state of the buffer, so the data
    is still inside waiting to be flushed. */
-char *buffer_getstr (struct buffer *);
+char *buffer_getstr(struct buffer *);
 
 /* Returns 1 if there is no pending data in the buffer.  Otherwise returns 0. */
-int buffer_empty (struct buffer *);
+int buffer_empty(struct buffer *);
 
-typedef enum
-  {
-    /* An I/O error occurred.  The buffer should be destroyed and the
-       file descriptor should be closed. */
-    BUFFER_ERROR = -1,
+typedef enum {
+       /* An I/O error occurred.  The buffer should be destroyed and the
+          file descriptor should be closed. */
+       BUFFER_ERROR = -1,
 
-    /* The data was written successfully, and the buffer is now empty
-       (there is no pending data waiting to be flushed). */
-    BUFFER_EMPTY = 0,
+       /* The data was written successfully, and the buffer is now empty
+          (there is no pending data waiting to be flushed). */
+       BUFFER_EMPTY = 0,
 
-    /* There is pending data in the buffer waiting to be flushed.  Please
-       try flushing the buffer when select indicates that the file descriptor
-       is writeable. */
-    BUFFER_PENDING = 1
-  } buffer_status_t;
+       /* There is pending data in the buffer waiting to be flushed.  Please
+          try flushing the buffer when select indicates that the file
+          descriptor
+          is writeable. */
+       BUFFER_PENDING = 1
+} buffer_status_t;
 
 /* Try to write this data to the file descriptor.  Any data that cannot
    be written immediately is added to the buffer queue. */
-extern buffer_status_t buffer_write(struct buffer *, int fd,
-                                   const void *, size_t);
+extern buffer_status_t buffer_write(struct buffer *, int fd, const void *,
+                                   size_t);
 
-/* This function attempts to flush some (but perhaps not all) of 
+/* This function attempts to flush some (but perhaps not all) of
    the queued data to the given file descriptor. */
 extern buffer_status_t buffer_flush_available(struct buffer *, int fd);
 
@@ -84,12 +83,12 @@ extern buffer_status_t buffer_flush_available(struct buffer *, int fd);
 /* Call buffer_flush_available repeatedly until either all data has been
    flushed, or an I/O error has been encountered, or the operation would
    block. */
-extern buffer_status_t buffer_flush_all (struct buffer *, int fd);
+extern buffer_status_t buffer_flush_all(struct buffer *, int fd);
 
 /* Attempt to write enough data to the given fd to fill a window of the
    given width and height (and remove the data written from the buffer).
 
-   If !no_more, then a message saying " --More-- " is appended. 
+   If !no_more, then a message saying " --More-- " is appended.
    If erase is true, then first overwrite the previous " --More-- " message
    with spaces.
 
@@ -97,7 +96,7 @@ extern buffer_status_t buffer_flush_all (struct buffer *, int fd);
    to return -1 (because the logic for handling the erase and more features
    is too complicated to retry the write later).
 */
-extern buffer_status_t buffer_flush_window (struct buffer *, int fd, int width,
-                                           int height, int erase, int no_more);
+extern buffer_status_t buffer_flush_window(struct buffer *, int fd, int width,
+                                          int height, int erase, int no_more);
 
 #endif /* _ZEBRA_BUFFER_H */