acl::queue_file类 参考

#include <queue_file.hpp>

类 acl::queue_file 继承关系图:

acl::queue_file 的协作图:

Public 成员函数
	queue_file ()
fstream *	get_fstream (void) const
time_t	get_ctime (void) const
bool	write (const void *data, size_t len)
int	format (const char *fmt,...) ACL_CPP_PRINTF(2
int int	vformat (const char *fmt, va_list ap)
int	read (void *buf, size_t len)
const char *	key (void) const
const char *	get_filePath (void) const
const char *	get_home (void) const
const char *	get_queueName (void) const
const char *	get_queueSub (void) const
const char *	get_extName (void) const
size_t	get_fileSize () const

友元
class	queue_manager

额外继承的成员函数
Protected 成员函数 继承自 acl::acl::noncopyable
	noncopyable ()
	~noncopyable ()

详细描述

在文件 queue_file.hpp 第 16 行定义.

构造及析构函数说明

queue_file()

acl::queue_file::queue_file

(

)

成员函数说明

format()

int acl::queue_file::format	(	const char *	fmt,
			...
	)

get_ctime()

time_t acl::queue_file::get_ctime

(

void

)

const

获得文件创建时间

返回

{time_t}, 返回自 1970 年以来的秒数, 如果返回值为 (time_t) -1, 则表示出错

get_extName()

const char* acl::queue_file::get_extName ( void  ) const

inline

获得该队列文件的扩展名

返回

{const char*} 扩展名称

在文件 queue_file.hpp 第 103 行定义.

        {
                return m_extName;
        }

get_filePath()

const char* acl::queue_file::get_filePath ( void  ) const

inline

获得队列文件的访问全路径

返回

{const char*}

在文件 queue_file.hpp 第 67 行定义.

        {
                return m_filePath.c_str();
        }

get_fileSize()

size_t acl::queue_file::get_fileSize ( ) const

inline

获得已经写入的数据大小尺寸

返回

{size_t}

在文件 queue_file.hpp 第 112 行定义.

        {
                return nwriten_;
        }

get_fstream()

fstream* acl::queue_file::get_fstream

(

void

)

const

获得文件流指针

返回

{acl::fstream*} 文件流指针, 如果为 NULL 则说明文件还未打开

get_home()

const char* acl::queue_file::get_home ( void  ) const

inline

获得队列文件的根路径部分(不含队列目录)

返回

{const char*}

在文件 queue_file.hpp 第 76 行定义.

        {
                return m_home;
        }

get_queueName()

const char* acl::queue_file::get_queueName ( void  ) const

inline

获得该队列文件的队列名

返回

{const char*} 队列名称

在文件 queue_file.hpp 第 85 行定义.

        {
                return m_queueName;
        }

get_queueSub()

const char* acl::queue_file::get_queueSub ( void  ) const

inline

获得队列子目录

返回

{const char*} 队列子目录名

在文件 queue_file.hpp 第 94 行定义.

        {
                return m_queueSub;
        }

key()

const char* acl::queue_file::key ( void  ) const

inline

取得本队列文件的键值, 该值即是队列文件的部分文件名(不含路径, 扩展名)

返回

{const char*} 队列文件键值

在文件 queue_file.hpp 第 58 行定义.

        {
                return m_partName;
        }

read()

int acl::queue_file::read	(	void *	buf,
		size_t	len
	)

从文件中读取数据

参数

buf	{void*} 缓存地址
len	{size_t} buf 大小

返回

{int} 读取的数据长度, -1: 表示读结束或读失败或输入参数错误, 应该关闭该文件对象, > 0: 表示成功

vformat()

int int acl::queue_file::vformat	(	const char *	fmt,
		va_list	ap
	)

write()

bool acl::queue_file::write	(	const void *	data,
		size_t	len
	)

向文件中写数据

参数

data	{const void*} 数据地址
len	{size} 数据长度

返回

{bool} 写数据是否成功

友元及相关函数文档

queue_manager

friend class queue_manager

friend

在文件 queue_file.hpp 第 118 行定义.

---

该类的文档由以下文件生成:

• include/acl_cpp/queue/queue_file.hpp