Botan::Output_Buffers Class Reference

#include <out_buf.h>

Public Member Functions
void	add (SecureQueue *queue)
size_t	get_bytes_read (Pipe::message_id msg) const
Pipe::message_id	message_count () const
	Output_Buffers ()=default
size_t	peek (uint8_t output[], size_t length, size_t stream_offset, Pipe::message_id msg) const
size_t	read (uint8_t output[], size_t length, Pipe::message_id msg)
size_t	remaining (Pipe::message_id msg) const
void	retire ()

Detailed Description

Container of output buffers for Pipe

Definition at line 23 of file out_buf.h.

Constructor & Destructor Documentation

Output_Buffers()

Botan::Output_Buffers::Output_Buffers ( )

default

Member Function Documentation

add()

void Botan::Output_Buffers::add

(

SecureQueue *

queue

)

Definition at line 63 of file out_buf.cpp.

                                           {
   BOTAN_ASSERT(queue, "queue was provided");
 
   BOTAN_ASSERT(m_buffers.size() < m_buffers.max_size(), "Room was available in container");
 
   m_buffers.push_back(std::unique_ptr<SecureQueue>(queue));
}

References BOTAN_ASSERT.

get_bytes_read()

size_t Botan::Output_Buffers::get_bytes_read

(

Pipe::message_id

msg

)

const

Definition at line 52 of file out_buf.cpp.

                                                              {
   SecureQueue* q = get(msg);
   if(q != nullptr) {
      return q->get_bytes_read();
   }
   return 0;
}

References Botan::SecureQueue::get_bytes_read().

message_count()

Pipe::message_id Botan::Output_Buffers::message_count

(

)

const

Definition at line 103 of file out_buf.cpp.

                                                   {
   return (m_offset + m_buffers.size());
}

peek()

size_t Botan::Output_Buffers::peek	(	uint8_t	output[],
		size_t	length,
		size_t	stream_offset,
		Pipe::message_id	msg ) const

Definition at line 30 of file out_buf.cpp.

                                                                                                           {
   SecureQueue* q = get(msg);
   if(q != nullptr) {
      return q->peek(output, length, stream_offset);
   }
   return 0;
}

References Botan::SecureQueue::peek().

read()

size_t Botan::Output_Buffers::read	(	uint8_t	output[],
		size_t	length,
		Pipe::message_id	msg )

Definition at line 19 of file out_buf.cpp.

                                                                               {
   SecureQueue* q = get(msg);
   if(q != nullptr) {
      return q->read(output, length);
   }
   return 0;
}

References Botan::SecureQueue::read().

remaining()

size_t Botan::Output_Buffers::remaining

(

Pipe::message_id

msg

)

const

Definition at line 41 of file out_buf.cpp.

                                                         {
   SecureQueue* q = get(msg);
   if(q != nullptr) {
      return q->size();
   }
   return 0;
}

References Botan::SecureQueue::size().

retire()

void Botan::Output_Buffers::retire

(

)

Definition at line 74 of file out_buf.cpp.

                            {
   for(auto& buf : m_buffers) {
      if(buf && buf->empty()) {
         buf.reset();
      }
   }
 
   while(!m_buffers.empty() && !m_buffers[0]) {
      m_buffers.pop_front();
      m_offset = m_offset + Pipe::message_id(1);
   }
}

---

The documentation for this class was generated from the following files:

• src/lib/filters/out_buf.h
• src/lib/filters/out_buf.cpp