Botan::DataSource_Command Class Reference

#include <unix_cmd.h>

Inheritance diagram for Botan::DataSource_Command:

Public Member Functions
bool	check_available (size_t n)
	DataSource_Command (const std::string &, const std::vector< std::string > &paths)
size_t	discard_next (size_t N)
bool	end_of_data () const
int	fd () const
std::string	id () const
size_t	peek (byte[], size_t, size_t) const
size_t	peek_byte (byte &out) const
size_t	read (byte[], size_t)
size_t	read_byte (byte &out)
	~DataSource_Command ()

Detailed Description

Command Output DataSource

Definition at line 49 of file unix_cmd.h.

Constructor & Destructor Documentation

DataSource_Command()

Botan::DataSource_Command::DataSource_Command	(	const std::string &	prog_and_args,
		const std::vector< std::string > &	paths )

DataSource_Command Constructor

Definition at line 220 of file unix_cmd.cpp.

                                                                          :
   MAX_BLOCK_USECS(100000), KILL_WAIT(10000)
   {
   arg_list = split_on(prog_and_args, ' ');
 
   if(arg_list.size() == 0)
      throw Invalid_Argument("DataSource_Command: No command given");
   if(arg_list.size() > 5)
      throw Invalid_Argument("DataSource_Command: Too many args");
 
   pipe = 0;
   create_pipe(paths);
   }

References Botan::split_on().

~DataSource_Command()

Botan::DataSource_Command::~DataSource_Command

(

)

DataSource_Command Destructor

Definition at line 238 of file unix_cmd.cpp.

   {
   if(!end_of_data())
      shutdown_pipe();
   }

References end_of_data().

Member Function Documentation

check_available()

bool Botan::DataSource_Command::check_available ( size_t n )

virtual

Implements Botan::DataSource.

Definition at line 102 of file unix_cmd.cpp.

   {
   throw Stream_IO_Error("Cannot check available bytes on a pipe");
   }

References Botan::Stream_IO_Error::Stream_IO_Error().

discard_next()

size_t Botan::DataSource::discard_next ( size_t N )

inherited

Discard the next N bytes of the data

Parameters

N	the number of bytes to discard

Returns

number of bytes actually discarded

Definition at line 35 of file data_src.cpp.

   {
   size_t discarded = 0;
   byte dummy;
   for(size_t j = 0; j != n; ++j)
      discarded += read_byte(dummy);
   return discarded;
   }

References read_byte().

Referenced by check_available().

end_of_data()

bool Botan::DataSource_Command::end_of_data ( ) const

virtual

Check if we reached EOF

Implements Botan::DataSource.

Definition at line 110 of file unix_cmd.cpp.

   {
   return (pipe) ? false : true;
   }

Referenced by peek(), Botan::Unix_EntropySource::poll(), read(), and ~DataSource_Command().

fd()

int Botan::DataSource_Command::fd

(

)

const

Return the Unix file descriptor of the pipe

Definition at line 118 of file unix_cmd.cpp.

   {
   if(!pipe)
      return -1;
   return pipe->fd;
   }

id()

std::string Botan::DataSource_Command::id ( ) const

virtual

Return a human-readable ID for this stream

Reimplemented from Botan::DataSource.

Definition at line 128 of file unix_cmd.cpp.

   {
   return "Unix command: " + arg_list[0];
   }

peek()

size_t Botan::DataSource_Command::peek ( byte [], size_t , size_t  ) const

virtual

Peek at the pipe contents

Implements Botan::DataSource.

Definition at line 95 of file unix_cmd.cpp.

   {
   if(end_of_data())
      throw Invalid_State("DataSource_Command: Cannot peek when out of data");
   throw Stream_IO_Error("Cannot peek/seek on a command pipe");
   }

References end_of_data(), Botan::Invalid_State::Invalid_State(), and Botan::Stream_IO_Error::Stream_IO_Error().

peek_byte()

size_t Botan::DataSource::peek_byte ( byte & out ) const

inherited

Peek at one byte.

Parameters

out	an output byte

Returns

length in bytes that was actually read and put into out

Definition at line 27 of file data_src.cpp.

   {
   return peek(&out, 1, 0);
   }

References peek().

Referenced by check_available(), and Botan::ASN1::maybe_BER().

read()

size_t Botan::DataSource_Command::read ( byte buf[], size_t length )

virtual

Read from the pipe

Implements Botan::DataSource.

Definition at line 63 of file unix_cmd.cpp.

   {
   if(end_of_data())
      return 0;
 
   fd_set set;
   FD_ZERO(&set);
   FD_SET(pipe->fd, &set);
 
   struct ::timeval tv;
   tv.tv_sec = 0;
   tv.tv_usec = MAX_BLOCK_USECS;
 
   ssize_t got = 0;
   if(::select(pipe->fd + 1, &set, 0, 0, &tv) == 1)
      {
      if(FD_ISSET(pipe->fd, &set))
         got = ::read(pipe->fd, buf, length);
      }
 
   if(got <= 0)
      {
      shutdown_pipe();
      return 0;
      }
 
   return static_cast<size_t>(got);
   }

References end_of_data(), and read().

Referenced by Botan::Unix_EntropySource::poll(), and read().

read_byte()

size_t Botan::DataSource::read_byte ( byte & out )

inherited

Read one byte.

Parameters

out	the byte to read to

Returns

length in bytes that was actually read and put into out

Definition at line 19 of file data_src.cpp.

   {
   return read(&out, 1);
   }

References read().

Referenced by check_available(), Botan::PEM_Code::decode(), discard_next(), and Botan::PGP_decode().

---

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

• src/entropy/unix_procs/unix_cmd.h
• src/entropy/unix_procs/unix_cmd.cpp