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

《cStor云存储系统API开发手册初稿_20130109》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、cStor云存储系统API开发手册cStor云存储系统API开发手册12/12南京云创存储科技有限公司2012-01-09cStor云存储系统API开发手册目录一、引言31.1.编写目的31.2.更新时间3二、获取方法3三、系统高速API33.1.总体设计33.2.使用方法43.3.数据结构43.3.1错误类型定义43.3.2文件打开类型定义53.4.函数说明53.4.1cstor_client_init53.4.2cstor_client_destroy53.4.3cstor_create_file63.4.4cstor_cr

2、eate_directory63.4.5cstor_open_file73.4.6cstor_close_file83.4.7cstor_write_by_filename83.4.8cstor_write_by_filebuff93.4.9cstor_read_by_filename103.4.10cstor_read_by_filebuff103.5.附加说明1112/12南京云创存储科技有限公司2012-01-09cStor云存储系统API开发手册一、引言1.1.编写目的cStor通过API的方式开放一些应用接口，这篇文档

3、用来介绍cStor目前开放的系统高速API，为应用程序的开发人员提供技术和文档服务。1.2.更新时间最后修订日期：2013-01-09版本号：v1.0二、获取方法三、系统高速API2.3.3.1.总体设计cStor系统高速API可实现对客户端的初始化及注销，文件的创建、打开、关闭，以及文件以文件名直接读写和从文件缓冲区以一定的偏移量并行读写功能,以提高系统性能。12/12南京云创存储科技有限公司2012-01-09cStor云存储系统API开发手册1.1.使用方法本API的使用说明如下：1)添加库文件环境变量；在Linux环境下

4、：echo"exportLD_LIBRARY_PATH=/opt/cstor/lib:$LD_LIBRARY_PATH">>~/.bashrc在Windows环境下：2)编写应用程序，编译即可。1.2.数据结构1.2.3.3.1.3.2.3.3.33.13.23.3.1错误类型定义#defineCSTOR_SUCCESS0/*操作成功/#defineCSTOR_ERROR-1/*GeneralError/#defineCSTOR_ERROR_FILE_EXISTS-2/*文件已存在/#defineCSTOR_ERROR_FILE

5、_NOT_EXISTS-3/*文件不存在/#defineCSTOR_NAME_TOO_LONG-4/*名字太长/#defineCSTOR_FILE_TOO_LONG-5/*文件太长/#defineCSTOR_UNREG_FILE-6/*文件未注册/#defineCSTOR_FILE_INFO_ERROR-7/*文件信息错误/12/12南京云创存储科技有限公司2012-01-09cStor云存储系统API开发手册#defineCSTOR_INPUT_INFO_ERROR-8/*输入信息错误/#defineCSTOR_NOT_FIL

6、E-9/*非文件/3.3.1文件打开类型定义enum{IO_NONE,IO_READ,IO_WRITE,IO_READONLY,IO_WRITEONLY};1.1.函数说明3.4.1cstor_client_init函数功能：根据配置文件参数初始化客户端函数原型：intcstor_client_init(constchar*conf_filename);参数说明：conf_filename:配置文件名返回值：return:0success,!=0fail,returntheerrorcode（操作成功则返回0，失败时为非0值，

7、返回具体错误类型）示例代码:3.4.2cstor_client_destroy函数功能：客户端注销函数原型：voidcstor_client_destroy();12/12南京云创存储科技有限公司2012-01-09cStor云存储系统API开发手册返回值：此函数不需要返回值示例代码：3.4.1cstor_create_file函数功能：创建一个文件函数原型：intcstor_create_file(constchar*filename,intoverwrite);参数说明：filename：要创建文件的文件名overwrite

8、：是否需要覆盖原文件（如已存在则覆盖，暂不支持覆盖）返回值：return:0success,!=0fail,returntheerrorcode（操作成功则返回0，失败时为非0值，返回具体错误类型）示例代码：3.4.2cstor_create_directory