stream_input_common Class Reference

interface of stream implementation for reading from file, socket More...

#include <miscxml.h>

Inheritance diagram for stream_input_common:

List of all members.

Public Member Functions
	stream_input_common (mem_pool_t &small_pool, mem_pool_t &big_pool, size_t xml_size, bool subset, size_t timeout=10000)
	constructor
bool	open (const xml_stream_attribute &location)
	opens stream source
void	close ()
	closes stream
virtual	~stream_input_common ()
	destructor
Protected Member Functions
virtual bool	data_request (ub1_t *buf, size_t &len)
	gets actual data from stream
Private Attributes
xml_stream_protocol	_protocol
	stream protocol
FILE *	_desc
	file decriptor
size_t	_timeout
	timeout
ub4_t	_file_length
	file length

---

Detailed Description

interface of stream implementation for reading from file, socket

Definition at line 135 of file miscxml.h.

---

Constructor & Destructor Documentation

stream_input_common::stream_input_common	(	mem_pool_t &	small_pool,
		mem_pool_t &	big_pool,
		size_t	xml_size,
		bool	subset,
		size_t	timeout = 10000
	)

constructor

Parameters:

small_pool	small memory pool
big_pool	big memory pool
xml_size	xml size - just a tip
subset	subset flag
timeout	timeout for sockets

Definition at line 581 of file miscxml.cpp.

stream_input_common::~stream_input_common

(

)

[virtual]

destructor

Definition at line 591 of file miscxml.cpp.

References close().

---

Member Function Documentation

bool stream_input_common::open

(

const xml_stream_attribute &

location

)

opens stream source

Parameters:

location

location attribute

Definition at line 652 of file miscxml.cpp.

References _desc, _file_length, xml_stream_attribute::_host, xml_stream_attribute::_port, xml_stream_attribute::_protocol, _protocol, _timeout, byte_source::_url, ch_cr, ch_lf, close(), terimber_socket::close(), xml_stream_attribute::combine_url(), terimber_socket::connect(), base_string< T >::length(), xml_stream_attribute::prepare_socket_request(), terimber_socket::receive(), terimber_socket::resolve_address(), terimber_socket::send(), terimber_socket::set_address(), STREAM_FILE, STREAM_FTP, STREAM_HTTP, STREAM_LOCAL, STREAM_RELATIVE, STREAM_UNKNOWN, str_template::strlen(), and str_template::strscan().

Referenced by xml_designer_impl::load(), buffer_loader::load(), and xml_processor::parseDTD().

void stream_input_common::close

(

)

closes stream

Reimplemented from terimber_socket.

Definition at line 749 of file miscxml.cpp.

References _desc, _file_length, _protocol, terimber_socket::close(), STREAM_FILE, STREAM_FTP, STREAM_HTTP, STREAM_LOCAL, STREAM_RELATIVE, and STREAM_UNKNOWN.

Referenced by data_request(), buffer_loader::load(), open(), xml_processor::parseDTD(), and ~stream_input_common().

bool stream_input_common::data_request	(	ub1_t *	buf,
		size_t &	len
	)			[protected, virtual]

gets actual data from stream

Parameters:

buf	pre-allocated buffer
len	[in,out] [in] buffer size, [out] obtained bytes

Implements byte_source.

Definition at line 598 of file miscxml.cpp.

References _desc, _file_length, _protocol, _timeout, close(), terimber_socket::receive(), STREAM_FILE, STREAM_FTP, STREAM_HTTP, STREAM_LOCAL, STREAM_RELATIVE, and STREAM_UNKNOWN.

---

Member Data Documentation

xml_stream_protocol stream_input_common::_protocol [private]

stream protocol

Definition at line 165 of file miscxml.h.

Referenced by close(), data_request(), and open().

FILE* stream_input_common::_desc [private]

file decriptor

Definition at line 166 of file miscxml.h.

Referenced by close(), data_request(), and open().

size_t stream_input_common::_timeout [private]

timeout

Definition at line 167 of file miscxml.h.

Referenced by data_request(), and open().

ub4_t stream_input_common::_file_length [private]

file length

Definition at line 168 of file miscxml.h.

Referenced by close(), data_request(), and open().

---

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

• miscxml.h
• miscxml.cpp