diff options
Diffstat (limited to 'src/include/k5-buf.h')
-rw-r--r-- | src/include/k5-buf.h | 75 |
1 files changed, 36 insertions, 39 deletions
diff --git a/src/include/k5-buf.h b/src/include/k5-buf.h index 621d7d3cb..c5576a3e3 100644 --- a/src/include/k5-buf.h +++ b/src/include/k5-buf.h @@ -66,68 +66,65 @@ struct k5buf { size_t xx_len; }; -/** Initialize a k5buf using a fixed-sized, existing buffer. SPACE must be +/* Initialize a k5buf using a fixed-sized, existing buffer. SPACE must be * more than zero, or an assertion failure will result. */ -void krb5int_buf_init_fixed(struct k5buf *buf, char *data, size_t space); +void k5_buf_init_fixed(struct k5buf *buf, char *data, size_t space); -/** Initialize a k5buf using an internally allocated dynamic buffer. The - * buffer contents must be freed with krb5int_free_buf. */ -void krb5int_buf_init_dynamic(struct k5buf *buf); +/* Initialize a k5buf using an internally allocated dynamic buffer. The + * buffer contents must be freed with k5_free_buf. */ +void k5_buf_init_dynamic(struct k5buf *buf); -/** Add a C string to BUF. */ -void krb5int_buf_add(struct k5buf *buf, const char *data); +/* Add a C string to BUF. */ +void k5_buf_add(struct k5buf *buf, const char *data); -/** +/* * Add a counted set of bytes to BUF. It is okay for DATA[0..LEN-1] * to contain null bytes if you are prepared to deal with that in the - * output (use krb5int_buf_len to retrieve the length of the output). + * output (use k5_buf_len to retrieve the length of the output). */ -void krb5int_buf_add_len(struct k5buf *buf, const char *data, size_t len); +void k5_buf_add_len(struct k5buf *buf, const char *data, size_t len); -/** Add sprintf-style formatted data to BUF. */ -void krb5int_buf_add_fmt(struct k5buf *buf, const char *fmt, ...) +/* Add sprintf-style formatted data to BUF. */ +void k5_buf_add_fmt(struct k5buf *buf, const char *fmt, ...) #if !defined(__cplusplus) && (__GNUC__ > 2) __attribute__((__format__(__printf__, 2, 3))) #endif ; -/** Truncate BUF. LEN must be between 0 and the existing buffer +/* Truncate BUF. LEN must be between 0 and the existing buffer * length, or an assertion failure will result. */ -void krb5int_buf_truncate(struct k5buf *buf, size_t len); +void k5_buf_truncate(struct k5buf *buf, size_t len); -/** +/* * Retrieve the byte array value of BUF, or NULL if there has been an * allocation failure or the fixed buffer ran out of room. - + * * The byte array will be a C string unless binary data was added with - * krb5int_buf_add_len; it will be null-terminated regardless. - * Modifying the byte array does not invalidate the buffer, as long as - * its length is not changed. - - * For a fixed buffer, the return value will always be equal to the - * passed-in value of DATA at initialization time if it is not NULL. - + * k5_buf_add_len; it will be null-terminated regardless. Modifying the byte + * array does not invalidate the buffer, as long as its length is not changed. + * + * For a fixed buffer, the return value will always be equal to the passed-in + * value of DATA at initialization time if it is not NULL. + * * For a dynamic buffer, any buffer modification operation except - * krb5int_buf_truncate may invalidate the byte array address. + * k5_buf_truncate may invalidate the byte array address. */ -char *krb5int_buf_data(struct k5buf *buf); +char *k5_buf_data(struct k5buf *buf); -/** - * Retrieve the length of BUF, or -1 if there has been an allocation - * failure or the fixed buffer ran out of room. The length is equal - * to strlen(krb5int_buf_data(buf)) unless binary data was added with - * krb5int_buf_add_len. +/* + * Retrieve the length of BUF, or -1 if there has been an allocation failure or + * the fixed buffer ran out of room. The length is equal to + * strlen(k5_buf_data(buf)) unless binary data was added with k5_buf_add_len. */ -ssize_t krb5int_buf_len(struct k5buf *buf); +ssize_t k5_buf_len(struct k5buf *buf); -/** - * Free the storage used in the dynamic buffer BUF. The caller may - * choose to take responsibility for freeing the return value of - * krb5int_buf_data instead of using this function. If BUF is a fixed - * buffer, an assertion failure will result. It is unnecessary - * (though harmless) to free a buffer after an error is detected; the - * storage will already have been freed in that case. +/* + * Free the storage used in the dynamic buffer BUF. The caller may choose to + * take responsibility for freeing the return value of k5_buf_data instead of + * using this function. If BUF is a fixed buffer, an assertion failure will + * result. It is unnecessary (though harmless) to free a buffer after an error + * is detected; the storage will already have been freed in that case. */ -void krb5int_free_buf(struct k5buf *buf); +void k5_free_buf(struct k5buf *buf); #endif /* K5_BUF_H */ |