cStor云存储系统API开发手册初稿_20130109.doc

cStor云存储系统 API开发手册  目录 一、 引言 3 1.1. 编写目的 3 1.2. 更新时间 3 二、 获取方法 3 三、 系统高速API 3 3.1. 总体设计 3 3.2. 使用方法 4 3.3. 数据结构 4 3.3.1 错误类型定义 4 3.3.2 文件打开类型定义 5 3.4. 函数说明 5 3.4.1 cstor_client_init 5 3.4.2 cstor_client_destroy 5 3.4.3 cstor_create_file 6 3.4.4 cstor_create_directory 6 3.4.5 cstor_open_file 7 3.4.6 cstor_close_file 8 3.4.7 cstor_write_by_filename 8 3.4.8 cstor_write_by_filebuff 9 3.4.9 cstor_read_by_filename 10 3.4.10 cstor_read_by_filebuff 10 3.5. 附加说明 11  引言 编写目的 cStor通过API的方式开放一些应用接口，这篇文档用来介绍cStor目前开放的系统高速API，为应用程序的开发人员提供技术和文档服务。 更新时间 最后修订日期：2013-01-09 版本号：v1.0 获取方法 系统高速API 总体设计 cStor系统高速 API可实现对客户端的初始化及注销，文件的创建、打开、关闭，以及文件以文件名直接读写和从文件缓冲区以一定的偏移量并行读写功能,以提高系统性能。 使用方法 本API的使用说明如下： 添加库文件环境变量； 在Linux环境下： echo export LD_LIBRARY_PATH=/opt/cstor/lib:$LD_LIBRARY_PATH ~/.bashrc 在Windows环境下： 编写应用程序，编译即可。 数据结构 错误类型定义 #define CSTOR_SUCCESS 0 /*操作成功 / #define CSTOR_ERROR -1 /* General Error / #define CSTOR_ERROR_FILE_EXISTS -2/* 文件已存在 / #define CSTOR_ERROR_FILE_NOT_EXISTS -3/* 文件不存在 / #define CSTOR_NAME_TOO_LONG -4/* 名字太长/ #define CSTOR_FILE_TOO_LONG -5/* 文件太长 / #define CSTOR_UNREG_FILE -6/* 文件未注册/ #define CSTOR_FILE_INFO_ERROR -7/* 文件信息错误 / #define CSTOR_INPUT_INFO_ERROR -8/* 输入信息错误/ #define CSTOR_NOT_FILE -9/* 非文件/ 文件打开类型定义 enum {IO_NONE,IO_READ,IO_WRITE,IO_READONLY,IO_WRITEONLY}; 函数说明 cstor_client_init 函数功能：根据配置文件参数初始化客户端 函数原型：int cstor_client_init(const char* conf_filename); 参数说明： conf_filename:配置文件名 返回值：return: 0 success, !=0 fail, return the error code （操作成功则返回0，失败时为非0值，返回具体错误类型） 示例代码: cstor_client_destroy 函数功能：客户端注销 函数原型：void cstor_client_destroy(); 返回值：此函数不需要返回值 示例代码： cstor_create_file 函数功能：创建一个文件 函数原型：int cstor_create_file(const char* filename, int overwrite); 参数说明： filename：要创建文件的文件名 overwrite：是否需要覆盖原文件（如已存在则覆盖，暂不支持覆盖） 返回值：return: 0 success, !=0 fail, return the error code （操作成功则返回0，失败时为非0值，返回具体错误类型） 示例代码： cstor_create_directo