The SSH buffer functions.
[The libssh API]

Functions to handle SSH buffers. More...

Functions
void	ssh_buffer_free (struct ssh_buffer_struct *buffer)
	Deallocate a SSH buffer.
void *	ssh_buffer_get_begin (struct ssh_buffer_struct *buffer)
	Get a pointer on the head of a buffer.
uint32_t	ssh_buffer_get_len (struct ssh_buffer_struct *buffer)
	Get the length of the buffer, not counting position.
ssh_buffer_struct *	ssh_buffer_new (void)
	Create a new SSH buffer.

---

Detailed Description

Functions to handle SSH buffers.

---

Function Documentation

void ssh_buffer_free

(

struct ssh_buffer_struct *

buffer

)

Deallocate a SSH buffer.

Parameters:

[in]

buffer

The buffer to free.

void* ssh_buffer_get_begin

(

struct ssh_buffer_struct *

buffer

)

Get a pointer on the head of a buffer.

Parameters:

[in]

buffer

The buffer to get the head pointer.

Returns:

A data pointer on the head. It doesn't take the position into account.

Warning:

Don't expect data to be nul-terminated.

See also:

buffer_get_rest()

buffer_get_len()

uint32_t ssh_buffer_get_len

(

struct ssh_buffer_struct *

buffer

)

Get the length of the buffer, not counting position.

Parameters:

[in]

buffer

The buffer to get the length from.

Returns:

The length of the buffer.

See also:

buffer_get()

struct ssh_buffer_struct* ssh_buffer_new

(

void

)

Create a new SSH buffer.

Returns:

A newly initialized SSH buffer, NULL on error.

---