forked from forhappy/OSSC
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mainpage.h
2240 lines (2220 loc) · 96.9 KB
/
mainpage.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* =============================================================================
*
* Filename: mainpage.h
*
* Description: mainpage content
*
* Company: ICT ( Institute Of Computing Technology, CAS )
*
* =============================================================================
*/
/** @mainpage OSSC 开发者手册
*******************************************************************************
* @section What_is_OSSC OSSC介绍 (OSS C SDK)
* OSSC(Aliyun Open Storage Service C SDK)为阿里云开放存储服务(OSS)提供了一套完整易用的 C SDK,并取名为 OSSC。
* @subpage OSSC_INTRO
* @subsection 关于OSS
* 阿里云存储服务(Open Storage Service,简称 OSS),是阿里云对外提供的海量,安全,低成本,高可靠的云存储服务。
* 用户可以通过简单的 REST 接口,在任何时间、任何地点、任何互联网设备上进行上传和下载数据,
* 也可以使用WEB 页面对数据进行管理。同时,OSS 提供 Java、Python、PHP SDK,简化用户的编程。
* 基于 OSS,用户可以搭建出各种多媒体分享网站、网盘、个人企业数据备份等基于大规模数据的服务。
* 【摘自《OSS API 开放接口规范文档》】。
*
* @subsection 我们为OSS做了什么?
* 目前 OSSC 提供了 OSS 开放接口中所描述的所有功能, 特点包括:
* -# Bucket 所有操作,如创建 Bucket、删除 Bucket、获取某个 Bucket 访问权限、设置 Bucket 访问权限、获取所有 Bucket 信息、
* 获取 Bucket 中所有 Object 的信息。
* -# Object 所有操作,创建 Object(PUT),获取 Object,删除 Object,获取 Object 元信息,拷贝 Object,一次性删除多个 Object,另外,还在此基础上\n
* 实现了从文件上传 Object、从内存缓冲区上传 Object、下载 Object 至文件、下载 Object 至内存缓冲区、多线程断点续传上传大文件。
* -# Multipart Upload 操作,初始化 Multipart Upload、上传 Part、完成 Multipart 上传、终止 Multipart Upload、查看 Multipart Upload,查看正在上传的 Part。
* -# Object Group 操作,创建 Object Group,获取 Object Group,获取 Object Group 中的 Object List 信息、获取 Object Group 元信息,删除 Object Group。
*
* @subsection oss_compression_format OSS 文件压缩格式
* 我们为OSS设计了一种可支持多种实时压缩算法(如LZO, LZ4,LZF)的文件存储格式,并实现了LZO,LZ4两种压缩算法(今后可能支持更多)的文件和内存块的实时压缩上传和下载解压缩功能,用户在压缩上传文件时需要指定压缩算法(目前只能指定OSS_LZ4, OSS_LZO),但是在下载解压缩时并不需要指定解压缩算法,OSSC会自动根据文件格式选择适当的解压缩算法对文件或内存块进行解压缩。
*
* 该压缩存储格式文件名称以.ossz结尾,但是不强制使用.ossz后缀,事实上,你可以使用任意文件名和后缀,OSSC会自动检查文件是否为合法的压缩格式。
* 另外,我们为文件和内存块的实时压缩上传和下载解压缩分别提供了相应的API,我们建议压缩上传和下载API成对使用,即上传时如果采用压缩上传,下载最好采用压缩下载的API进行文件下载,以免在下载解压缩时不必要的文件格式检查,更详细的原理可以参考《OSSC 实现原理》一节,或源码 src/util/oss_compression.c, src/util/oss_decompress 或 src/core/client_object_operation.c。
*
* @subsection OSSC亮点
* 目前 OSSC 除了提供 OSS 开放接口中所描述的所有功能以外,还包括以下亮点:
* - 多线程断点上传功能;
* - 文件实时压缩上传和实时解压缩下载;
* - 内存块实时压缩上传和实时解压缩下载;
* - 简易的文件夹同步上传和同步下载功能。
*
* @note 由于在Get Object操作设置HTTP的Range请求参数时会出现:"connection reset by peer",无法进行测试,所以多线程断点下载功能未经过测试,没有集成到代码库中。
*******************************************************************************
* @section OSSC安装细节
* @subpage OSSC_INSTALL
* @subsection 操作系统
* OSSC 在 Ubuntu 12.04 上开发,我们测试了OSSC在不同Linux操作系统发行版的稳定性,以下是OSSC经过测试操作系统:
* - Ubuntu 12.04, 11.10, 11.04, 10.10, 10.04
* - CentOS 5.5
* - Fedora 15, 16, 17
* - openSUSE 12.2
*
* @attention 目前我们没有在Windows上经过严格测试,虽然 OSSC 是标准C (C99) 写的,理论上也可以在 Windows 上编译运行,但是目前不建议在Windows系统下使用 OSSC,我们以后会对此改进。
*
* @subsection OSSC依赖库
* OSSC 采用 CURL 库处理 HTTP 请求,因此在编译 OSSC 之前你需要安装 CURL,CURL 源码中包含了C调用API,最新版 CURL下载地址:http://curl.haxx.se/libcurl/。
* 除此之外,OSSC 不依赖任何其他程序库。
*
* @subsubsection CURL安装
* 本节介绍如何编译 CURL
*
* -# 下载 CURL,http://curl.haxx.se/download.html
* -# 安装 CURL,在Unix/Linux按照如下步骤,
* @code
* $ ./configure
* $ make
* $ make test (optional)
* $ make install(需root用户权限)
* @endcode
* 你也可以参考 CURL 的官方安装文档,http://curl.haxx.se/docs/install.html
* -# 完成依赖库安装后执行 ldconfig(需root用户权限)
*
* @subsection OSSC编译步骤
* 本节介绍如何编译OSSC。
*
* OSSC采用 CMake 管理构建过程,应该先安装CMake,
* -# 安装CMake。
* -# 创建 build 目录,进入到该目录,mkdir build && cd build
* -# 执行 cmake ../.
* -# 编译和安装 make && make install
* @note 如果需要设置编译选项,可以参考CMake文档,目前默认的编译模式为 Release,如果需要调试OSSC,
* 请将编译模式设置为Debug。
*
* OSSC默认安装在 /usr/local目录下,当然你可以在 cmake 中设置,方法如下:
* @code
* cmake -DCMAKE_INSTALL_PREFIX=/your-path ../.
* @endcode
* @subsection 在你的程序中使用OSSC
* OSSC以程序库的形式提供给上层开发者使用,因此如果你想基于OSSC开发上层应用,必须链接OSSC程序库,OSSC大部分都集中到了 osscore 中,\n
* 只是支持多线程调用模式的API单独放在 ossextra库中(目前多线程只支持 pthread 线程库,后期会考虑在 Windows 下也支持多线程)\n
* 以下是你的程序需要连接OSSC,链接参数为:-L/path-to-your-ossc-installation -losscore.
*
* 另外需要注意的是,OSSC支持多线程断点续传模式下上传文件,如果你想体验该功能,你需要链接如下库:
* -L/path-to-your-ossc-installation -lossextra.
*******************************************************************************
* @section OSSC编码规范
* @subpage OSSC_CODING_STYLE
*
* 一个优秀的项目必须遵循良好的编码规范,良好的编码风格可以促进团队协作,减少 BUG 产生几率,有助于开发后的代码审查,降低后期维护成本。
*
* OSSC虽然只是我们在业余时间完成的小项目,但是也注重了编码风格的一致性,我们强烈建议那些希望基于OSSC做二次开发的编码人员阅读本规范,
* 相信本规范能够让你快速熟悉 OSSC 的整体结构和OSSC API 的使用方法。
*
*******************************************************************************
* @section OSSC实现原理
* OSSC详细的实现原理请参考:\subpage OSSC_INTERNAL
*
* @subsection 概括
* OSSC(OSS-C-SDK)完全采用C语言开发,并实现了类似面向对象的调用方式,即“对象(struct 结构)”的“成员函数(函数指针)“采用函数指针形式实现,
* 我们尽量和OSS-JAVA的使用方式切合,每个对象都有相关的头文件和实现文件,并存放在modules目录下,其中与oss功能相关的所有的文件名均以oss_为前缀,\n
* 每个文件实现了一个对象(即模块),另外,为了方便开发人员记忆,OSSC中的所有结构和函数我们采用如下命名;
*
* -# 类名(本文指代struct 结构)以 “oss_” 为前缀,并以 “_t” 为后缀,名字中间的单词用来标识该结构的用途,单词以下划线“_”连接,比如:包含终止一个Multipart上传事件的请求参数被命名为 \n
* oss_abort_multipart_upload_request_t,或者包含访问阿里云开放存储服务的入口“类”被命名为 oss_client_t,其他以此类推。
* -# 与各个类(struct 结构指针,以下均以“类”指代)对应的函数均以函数指针的形式调用(除了oss_client_t),比如oss_abort_multipart_upload_request_t中设置 Bucket 名称可以按照如下方式调用,
* @code
* request->set_bucket_name(request,"bucket-name-001");
* @endcode
* -# 所有类对外均提供初始化函数和析构函数,其它与该类相关的操作均通过该类的函数指针调用,其中初始化函数命名规则为:该类的(BARE)类名(即类名去掉“oss_”前缀和“_t”后缀)+initialize,
* 析构函数为该类的(BARE)类名(即类名去掉“oss_”前缀和“_t”后缀)+finalize。
* -# 访问阿里云开放存储服务(Open Storage Service, OSS)的入口“类”是 oss_client_t,与此对应的所有函数均以client_前缀开头,并且第一个参数都是指向client结构的指针。
*
* 比如上传一个对象,你需要定义标识上传对象的请求结构(oss_put_object_request_t *request)和\n
* 上传对象之后返回信息的结构(oss_put_object_result_t *result),然后将request作为参数传递给上传对象函数中(client_put_object_from_file()\n
* 或者client_put_object()中),最后返回值会保存在result指针所指向的结构中。
*
* 下面的代码概括了使用 OSSC 的步骤(单线程上传文件示例):
* @code
* const char *access_id = "ACSGmv9fkV1TDO9L";// Access ID
* const char *access_key = "BedoWbsje2"; // Access key
* const char *bucket_name = "bucketname001"; //Bucket 名称
* const char *key = "put-test.data"; // Key, Object 名称
*
* FILE *file = fopen("proactor.pdf", "r"); //打开需要上传的文件
* unsigned short retcode = 0; //设置返回码,关于返回码的定义将在后文中详细介绍
* oss_client_t *client = client_initialize(access_id, access_key); // 初始化 oss_client_t *clien
*
* oss_object_metadata_t *metadata = object_metadata_initialize(); // 初始化 oss_object_metadata_t *metadata
* metadata->set_content_length(metadata, file_len); // 设置 metadata 元信息
* metadata->set_content_type(metadata, "application/octet-stream"); // 设置 metadata 元信息
*
* client_put_object_from_file(client, bucket_name, key, file, metadata, &retcode);// 核心操作:调用上传对象API
* client_finalize(client); //使用以后程序退出时需要释放 oss_client_t *client 分配的空间
*
* @endcode
*
*******************************************************************************
* @section OSSC高级模块Extra库
* OSSC 高级模块中包含了多线程上传大文件的 API,并支持断点续传,由于时间和精力有限,我们目前并没有实现 Windows 平台的多线程上传下载功能,
* 希望今后会有其他开发者实现这一功能。
*
* 另外 Extra 库还支持简单的文件夹上传同步和下载同步的功能,希望该API对其他开发者有用。
*
* OSSC 采用了POSIX多线程标准库 pthread,理论上只要你的操作系统支持 pthread都可以使用 OSSC 的 extra 库中的 API。
* @subpage OSSC_EXTRA
*******************************************************************************
* @section API使用示例
*
* @subpage OSSC_API_EXAMPLE
*******************************************************************************
* @section 关于OSSC授权
* OSSC 使用的开源程序:
* -# GNUlib 中的 base64, sha1, hmac-sha1等模块,并进行了适当改造。
* -# CCAN 的 ttxml,一个极简单的 xml 文件只读库
* -# Glib 的 GString,进行了适当的改造,在此基础上实现了 tstring_t,一个类似 C++ 的 std::string实现
* -# UThash, A hash table for C structure, http://uthash.sourceforge.net/
* -# LZ4: http://code.google.com/p/lz4/
* -# miniLZO: http://www.oberhumer.com/opensource/lzo/
*
* OSSC 采用 LGPL(GNU Lesser General Public License:GNU 宽通用公共许可证)授权形式发布,有关 LGPL 可以查阅 GNU 官方文档:
* http://www.gnu.org/licenses/lgpl.html
*******************************************************************************
* @section 关于作者
* 傅海平:中国科学院计算技术研究所网络数据中心([email protected])\n
* 王 维:中国科院学计算技术研究所网络数据中心([email protected])
*/
/////////////////////////////////////////////////////////////////////////////////////////////////////
/** @page OSSC_INTRO OSSC详细介绍
* @section OSSC介绍
* @subsection OSS 简介
* 阿里云存储服务(OpenStorageService,简称 OSS),是阿里云对外提供的海量,安全,低成本,高可靠的云存储服务。
* 用户可以通过简单的 REST 接口,在任何时间、任何地点、任何互联网设备上进行上传和下载数据,
* 也可以使用WEB 页面对数据进行管理。同时,OSS 提供 Java、Python、PHP SDK,简化用户的编程。
* 基于 OSS,用户可以搭建出各种多媒体分享网站、网盘、个人企业数据备份等基于大规模数据的服务。
* 【摘自《OSS API 开放接口规范文档》】。
*
* @subsection OSSC概述
* 本项目为阿里云开放存储服务(OSS)提供了一套完整易用的 C SDK,并取名为 OSSC,
* 目前 OSSC 提供了 OSS 开放接口中所描述的所有功能, 特点包括:
* - Bucket 所有操作,如创建 Bucket、删除 Bucket、获取某个 Bucket 访问权限、设置 Bucket 访问权限、获取所有 Bucket 信息、
* 获取 Bucket 中所有 Object 的信息。
*
* - Object 所有操作,创建 Object(PUT),获取 Object,删除 Object,获取 Object 元信息,拷贝 Object,一次性删除多个 Object,另外,还在此基础上\n
* 实现了从文件上传 Object、从内存缓冲区上传 Object、下载 Object 至文件、下载 Object 至内存缓冲区、多线程断点续传上传大文件,断点续传下载文件。
*
* - Multipart Upload 操作,初始化 Multipart Upload、上传 Part、完成 Multipart 上传、终止 Multipart Upload、查看 Multipart Upload,查看正在上传的 Part。
*
* - Object Group 操作,创建 Object Group,获取 Object Group,获取 Object Group 中的 Object List 信息、获取 Object Group 元信息,删除 Object Group。
*
* @subsection OSSC亮点
* 目前 OSSC 除了提供 OSS 开放接口中所描述的所有功能以外,还包括以下亮点:
* - 多线程断点上传功能(由于设置Range参数时获取Ojbect请求总是出现:"connect reset by peer",所以多线程断点下载功能暂时未完成)
* - 文件实时压缩上传和实时解压缩下载;
* - 简易的文件夹同步上传和同步下载功能
*
* @subsection 我们的夙愿
* 我们是 OSSC(OSS C SDK) 的开发者,OSSC 为阿里云开放存储服务(OSS)提供了一套完整易用的 C SDK,目前 OSSC 相比 OSS JAVA可能还存在一些不足,程序稳定性有待检验,
* 但是在功能上完全实现了 OSS 开放接口,所以就功能而言,OSSC 已经达到在生产环境中使用的级别。
*
* 但是由于时间仓促,加上我们自身能力的有限,OSSC 目前不是十分完美,我们将它开源贡献出来,希望今后更多的人参与到 OSSC 项目上来,提高 OSSC 的稳定性,希望借此促进阿里云开放存储服务OSS的发展,同时我们也为开源贡献力量。
*
*/
/** @page OSSC_INSTALL OSSC安装步骤
* @section OSSC安装步骤
* @subsection OSSC依赖库
* OSSC 采用 CURL 库处理 HTTP 请求,因此在编译 OSSC 之前你需要安装 CURL,CURL 源码中包含了C调用API,最新版 CURL下载地址:http://curl.haxx.se/libcurl/。
* 除此之外,OSSC 不依赖任何其他程序库。
*
* @subsubsection CURL安装
* 本节介绍如何编译 CURL
*
* -# 下载 CURL,http://curl.haxx.se/download.html
* -# 安装 CURL,在Unix/Linux按照如下步骤,
* @code
* $ ./configure
* $ make
* $ make test (optional)
* $ make install(需root用户权限)
* @endcode
* 你也可以参考 CURL 的官方安装文档,http://curl.haxx.se/docs/install.html
* -# 完成依赖库安装后执行 ldconfig(需root用户权限)
*
* @subsection OSSC编译步骤
* 本节介绍如何编译OSSC。
*
* OSSC采用 CMake 管理构建过程,应该先安装CMake,
* -# 安装CMake。
* -# 创建 build 目录,进入到该目录,执行 cmake ../.
* -# 编译和安装 make && make install
*
* OSSC默认安装在 /usr/local目录下,当然你可以在 cmake 中设置。方法如下:
* @code
* cmake -DCMAKE_INSTALL_PREFIX=/your-path ../.
* @endcode
*
* @subsection 在你的程序中使用OSSC
* OSSC以程序库的形式提供给上层开发者使用,因此如果你想基于OSSC开发上层应用,必须链接OSSC程序库,OSSC大部分都集中到了 osscore 中,\n
* 只是支持多线程调用模式的API单独放在 ossextra库中(由于时间有限,目前多线程只支持 pthread 线程库,后期会考虑在 Windows 下也支持多线程)\n
* 以下是你的程序需要连接OSSC,链接参数为:-L/path-to-your-ossc-installation -losscore.
*
* 另外需要注意的是,OSSC支持多线程断点续传模式下上传和下载文件,如果你想体验该功能,你需要链接如下库:
* -L/path-to-your-ossc-installation -lossextra.
*/
/** @page OSSC_CODING_STYLE OSSC编码规范详述
* @section 编码规范的重要性
* 如前文所述,一个优秀的项目必须遵循良好的编码规范,良好的编码风格可以促进团队协作,减少 BUG 产生几率,有助于开发后的代码审查,降低后期维护成本。
* @section OSSC编码规范概述
* - OSSC 所有函数名和类名(即结构名,下同)均已小写字符书写,全局枚举量,常量和宏定义在include/ossc/oss_constants.h中。
*
* - 类名以 “oss_” 为前缀,并以 “_t” 为后缀,名字中间的单词(均为小写)用来标识该结构的用途,单词以下划线“_”连接,比如:包含终止一个Multipart上传事件的请求参数被命名为
* oss_abort_multipart_upload_request_t,或者包含访问阿里云开放存储服务的入口“类”被命名为 oss_client_t,其他以此类推。
*
* - 与各个类对应的函数均以函数指针的形式调用(除了oss_client_t, oss_client_t类相关的函数均以 "client_"为前缀,第一个参数是 oss_client_t 指针,比如client_create_bucket()),比如oss_abort_multipart_upload_request_t中设置 Bucket 名称可以按照如下方式调用,
* @code
* request->set_bucket_name(request,"bucket-name-001");
* @endcode
* @note 调用规则:类(即结构,如前文所述)的指针调用其内部的函数指针所指向的函数,该函数的第一个参数是其自身结构的指针,第二个参数开始就是该函数真正的参数,注意,这与 C++ 或 Java 的调用习惯相似,只是第一个参数固定为指向自身结构的指针。
*
* - 所有类对外均提供初始化函数和析构函数,其它与该类相关的操作均通过该类的函数指针调用,其中初始化函数命名规则为:该类的(BARE)类名(即类名去掉“oss_”前缀和“_t”后缀)+initialize,
* 析构函数为该类的(BARE)类名(即类名去掉“oss_”前缀和“_t”后缀)+finalize。
*
* - 访问阿里云开放存储服务(Open Storage Service, OSS)的入口“类”是 oss_client_t,与此对应的所有函数均以client_前缀开头,并且第一个参数都是指向client结构的指针。
* @section 源码目录介绍
* OSSC 的源码目录如下:
* @code
* .
* ├── AUTHORS
* ├── build
* ├── CMakeLists.txt
* ├── config.h.cmake.in
* ├── doc
* ├── include
* ├── LICENSE.txt
* ├── README.txt
* ├── src
* ├── example
* @endcode
*
* 其中
* - AUTHORS文件是作者(包括贡献者)的基本信息;
*
* - build 目录是构建目录,建议在该目录下构建 OSSC,实际上由于 OSSC 采用的是 CMake OUT-OF-SOURCE 构建方式,所以只能在该目录下编译 OSSC;
*
* - CMakeList.txt 是项目的顶级 CMake 脚本;
*
* - config.h.cmake.in 是 CMake 待检测的编译选项;
*
* - doc 目录包含了 OSSC 的所有文档;
*
* - include目录是包含了OSSC 所需的头文件;
*
* - LICENSE.txt 是OSSC的项目采用的开源条款;
*
* - README.txt是说明文档;
*
* - src是OSSC的全部源码;
*
* - example目录包含了一些 OSSC 的实际使用例子。
*
* @section 命名规则
*
* OSSC 完全采用C开发,遵循一套完整的命名规则,具体如下:
* @subsection 文件命名规则
* OSSC 实现了面向对象的调用方式,类的所有函数均以函数指针的方式实现。所有文件名均以 oss_ 开头,其中各个类(结构)的头文件主要存放在 include/ossc/modules目录下面,
* 对应的实现文件则存放在 src/modules 目录中,另外每个类的头文件和实现文件命名规则为 "oss_" + 类名小写(单词间采用下划线 “_” 连接),
* 比如 client 类(OSS 服务入口类)的实现文件是 src/moduels/oss_client.c,而对应的头文件则是 include/ossc/modules/oss_client.h。
*
* @subsection 类名,函数名,变量名,常量名,宏等命名规则
*
* - 类名以 “oss_” 为前缀,并以 “_t” 为后缀(内部定义为 struct oss_class_name_s),名字中间的单词(均为小写)用来标识该结构的用途,单词以下划线“_”连接,如 client 类命名为 oss_client_t。
*
* - OSSC 函数分为内部使用函数和提供给外部接口函数两类,其中内部使用的函数使用下划线“_”开头,另外函数名也均以小写书写,单词间以下划线“_”连接,
* OSSC 提供外部使用的函数也分为两小类,一种是 helper 函数,即辅助函数,此类函数也以 "oss_" 开头,后面跟实际函数名,一般而言函数名尽量体现函数功能,如计算 md5 的函数 oss_compute_md5_digest(),
* 或者获取文件大小 oss_get_file_size();另外一种是 core 函数,即 client类 (oss_client_t)的核心函数,此类函数均已 “cilent_”开头,其后名称也尽量体现该函数的功能,
* 比如下载 Object 至内存的函数是 client_get_object_to_buffer(),创建 Bucket 的函数名为 client_create_bucket();
*
* - 变量名均采用小写字母命名,单词间采用下划线连接“_”,可以合理缩写,但是应以准确易读为标准,对于无意义的循环变量,可以使用诸如 i, j, k类似的单个字母,但是并不推荐该方法。
*
* - 常量名(const)以“k”开头,其余字母或单词均用大写,如 kMYVAR,kPAGESIZE等。
*
* - 宏名均采用大写字母,一般以“OSS”开头,单词间以下划线“_“连接,如 OSS_HTTP_GET, OSS_CONTENT_TYPE。
*
* @subsection 其他命名规则
* 其他命名规则比较宽泛,OSSC 不作严格要求。
*
* @section 排版
* 以下内容部分参考:
* @sa https://innosoc.googlecode.com/files/%E7%BC%96%E7%A8%8B%E8%A7%84%E8%8C%83.pdf
* @subsection 缩进与对齐
* 缩进代码统一采用 4 格缩进,4 个空格或 Tab 字符,若采用 Tab 字符,应调整编辑器将 Tab 宽度设置为 4。另外,不要在代码中混合使用 Tab 和空格来进行缩进。
* @subsection 放置花括号
* 对于 if, for, while 等关键字,起始花括号放在该行的末尾,而对于函数的起始花括号则新起一行放置,如下面例子所示:
* @code
* static inline void
* __bucket_set_name(
* oss_bucket_t *bucket,
* const char *name,
* size_t name_len)
* {
* if (bucket->name != NULL) {
* free(bucket->name);
* bucket->name = NULL;
* }
* bucket->name = (char *)malloc(sizeof(char) * name_len + 1);
* strncpy(bucket->name, name, name_len);
* (bucket->name)[name_len] = '\0';
* }
* @endcode
* @subsection 空格
* - 双目运算符两侧,需要留有空格。如 “=”, “+=”,“>=”, “<=”, “+”, “&&”, “<<”, “^”等。
*
* - if, for, while, switch 等关键字之后,与紧接着的左括号‘(’之间,要留有一个空格。
*
* - 左花括号“{”之前,右括号“)”与左花括号“{”之间要留一空格。
*
* - 函数参数之间逗号‘,’分隔后面要留有空格。
*
* - for 语句分号‘;’分隔后面要留有空格。
*
* @subsection 空行
* - 函数定义的前后,均需要适当的空行。
*
* - 在函数体内,在一组变量定义完之后,需要适当空行。
*
* - 一段逻辑性相关的代码前后需要加空行。
*
* @subsection 代码行
* - 一行代码宽度应不超过 80 个字符,对于较长的语句,应该分行书写,增加代码的可读性。
*
* @section 注释
* OSSC 采用 Doxygen 进行文档维护,具体注释风格与 JAVADOC 一致,参见 Doxygen 官方网站。@sa http://www.stack.nl/~dimitri/doxygen/docblocks.html
*
* 另外,OSSC 头文件和实现文件开头均加上了如下语句:
* @code
* /\*
* * =============================================================================
* *
* * Filename: oss_part_listing.h
* *
* * Description: oss_part_listing.
* *
* * Created: 09/04/2012 08:57:48 PM
* *
* * Company: ICT ( Institute Of Computing Technology, CAS )
* *
* *
* * =============================================================================
* *\/
* @endcode
*
*/
/** @page OSSC_INTERNAL OSSC实现原理
*
* @section 概述
* OSSC(OSS-C-SDK)完全采用C语言开发,所有代码(头文件 + 实现文件 + 测试文件)合计约 2.2 万行,我们在 OSSC 中实现了类似面向对象的调用方式,\n
* 因此熟悉 OSS Java调用方式的开发者可以在很短的时间内掌握 OSS C SDK的使用。
*
* @section 代码目录结构
* @code
* .
* ├── AUTHORS
* ├── CMakeLists.txt
* ├── config.h.cmake.in
* ├── doc
* │ └── doxygen
* ├── include
* │ ├── ossc
* │ └── ossc-config.h
* ├── LICENSE.txt
* ├── README.txt
* ├── src
* │ ├── CMakeLists.txt
* │ ├── core
* │ ├── extra
* │ ├── lib
* │ ├── modules
* │ └── util
* ├── test
*
* @endcode
*
* OSSC 采用 CMake 管理项目构建过程,源码主要存放在 src 中,头文件在存放在 include 中,其中 include 目录结构如下:
* @code
* ├── ossc
* │ ├── client.h
* │ ├── modules
* │ ├── oss_constants.h
* │ ├── oss_curl_callback.h
* │ ├── oss_extra.h
* │ ├── oss_helper.h
* │ └── util
* └── ossc-config.h
* @endcode
* 如编码规范一节所述,modules目录主要存放了各个类(即 C 语言中结构 struct)的头文件,你不应该直接包含include这些头文件,因为modules下的头文件开始都包含了以下语句(各个头文件可能不同):
* @code
* #ifndef _OSS_PART_LISTING_H
* # error Never include <ossc/modules/oss_part_listing.h> directly,
* # error use <ossc/client.h> instead.
* #endif
* @endcode
*
* 如果你想使用 OSSC 的 API,你可以只包含 ossc/client.h文件即可,为了保险起见,你应该尽量包含 ossc/oss_helper.h 或 ossc/oss_extra.h(依赖pthread,仅在Unix/Linux下有效),ossc/util/oss_common.h 如下代码所示:
*
* @code
* #include <ossc/client.h>
* #include <ossc/oss_extra.h> // 多线程断点上传大文件功能,由于依赖pthread线程库,所以目前仅在Unix/Linux中可以使用。
* @endcode
*
*@attention
* 其中 ossc/oss_extra.h 里面包含了多线程断点上传大文件功能,由于依赖pthread线程库,所以目前仅在Unix/Linux中可以使用。
*
* 另外,src 目录结构如下:
* @code
* .
* ├── CMakeLists.txt
* ├── core
* ├── extra
* ├── lib
* ├── modules
* └── util
* @endcode
* - CMakeLists.txt: 该目录的CMake脚本;
* - core: OSSC 的核心代码,包含 Bucket,Object,Multipart Upload,Object Group 四类主要功能的实现及其辅助函数;
* - extra: extra 库的核心实现,包括多线程断点续传和文件夹上传同步和下载同步的功能;
* - lib: OSSC 的依赖库,包括 md5,hmac-sha1,sha1,base64和其他压缩库(LZ4, LZO)等功能;
* - modules: OSSC 各个结构实现代码;
* - util: OSSC 的工具函数,包括压缩库,签名验证函数,时间,字符串,XML解析等功能
*
* @section 对象实现
* OSSC 采用面向对象的方式构造每个结构(可以称之为类),每个对象对外只有初始化函数和析构函数,其他函数均采用函数指针方式调用,
* 所以一个典型的对象声明方式如下:
* @code
* // Bucket是OSS上的命名空间 \n
* // Bucket名在整个 OSS 中具有全局唯一性,且不能修改;
* // 存储在OSS上的每个Object必须都包含在某个Bucket中。
* // 一个应用,例如图片分享网站,可以对应一个或多个 Bucket。
* // 一个用户最多可创建 10 个Bucket, 但每个Bucket中存放的Object的数量和大小总和没有限制,
* // 用户不需要考虑数据的可扩展性。\n
* // Bucket 命名规范
* // - 只能包括小写字母,数字,下划线(_)和短横线(-)
* // - 必须以小写字母或者数字开头
* // - 长度必须在 3-255 字节之间
*
* struct oss_bucket_s {
* char *create_date; //< Bucket的创建时间
* char *name; //< Bucket的名称
* oss_owner_t *owner; //< Bucket的所有者
* const char * (*get_create_date)(oss_bucket_t *bucket);
* void (*set_create_date)(oss_bucket_t *bucket, const char *create_date);
* const char * (*get_name)(oss_bucket_t *bucket);
* void (*set_name)(oss_bucket_t *bucket, const char * name);
*
* oss_owner_t * (*get_owner)(oss_bucket_t *bucket);
* void (*set_owner)(oss_bucket_t *bucket, oss_owner_t *owner);
* };
*
* //
* // oss_bucket_t 构造函数
* // @return 返回一个标识Bucket的结构指针
* // @note 用户不需要句柄后要调用相应的finalize函数释放空间
* // @retval 非空 表示成功
* // @retval NULL 表示失败
*
* extern oss_bucket_t *
* bucket_initialize(void);
*
* //
* // oss_bucket_t 带bucket_name参数的构造函数
* // @return 返回一个标识Bucket的结构指针
* // @note 用户不需要句柄后要调用相应的finalize函数释放空间
* // @retval 非空 表示成功
* // @retval NULL 表示失败
* //
* extern oss_bucket_t *
* bucket_initialize_with_name(const char *name);
*
* //
* // oss_bucket_t 析构函数
* // @param bucket [in] 标识一个ACL的结构指针
* // @retval void
* // @pre bucket 必须使用bucket_initialize的返回值
* //
* extern void
* bucket_finalize(oss_bucket_t *bucket);
* @endcode
*
* @section 签名验证
* OSSC签名验证步骤遵循OSS标准签名验证方式,具体方式详见《OSS开放接口规范》
*
* @section 请求处理
* 我们使用 libcurl 发送请求并接受返回结果。libcurl 可以灵活处理多种网络协议,对于HTTP协议来说,
* 也可以灵活地生成请求方式和请求头部。OSSC的HTTP请求处理的核心代码位于src/core中,
* 因此具体方式可以参见src/core/client_object_operation.c或相关的实现文件。
*
* @section 返回结果解析与处理
* 由于返回结果可能是包含错误信息的XML格式文件,另外OSSC使用C开发,需要重复制造轮子,但是我们并没有使用类似expat,
* libxml2等“重量级”的库,而是选择了超轻量级的CCAN的ttxml库(http://ccodearchive.net/info/ttxml.html,一个xml文件只读库,
* 源码仅仅300行左右),我们并对它进行了适当的改造,所以返回结果解析与处理比较完整,详细实现请参考 src/util/ttxml和相关文件。
*
* @section 压缩文件格式描述
* 为了减少用户海量文件对OSS存储造成的压力,同时降低对网络带宽等有限资源的使用,
* OSSC 采用当前流行的实时压缩算法设计了一种针对阿里云存储服务的可扩展压缩文件格式。
*
* @subsection 为什么采用压缩文件上传
* 我们的实验也证明,该压缩文件格式由于支持多种实时压缩算法,因此可以在采用合理的压缩算法的情况下,
* 既保证用户不会损失很长的压缩时间,同时也有效减少用户上传文件大小20%-70%,
* 另外用户可以在压缩速度和压缩比之间进行取舍,该策略带来的好处是降低了OSS和用户双方的存储压力和网络带宽压力
*
* 经过进一步的实验我们发现,其实压缩过程时间损失完全可以由压缩后文件变小更利于上传而带来的网络传输时间减小而弥补,
* 某些时候后者带来的好处远远大于前者。
*
* 以LZ4压缩算法网站给出的数据(http://code.google.com/p/lz4/),假设采用LZ4(r59),压缩速率为 330MB/s,用户采用100M光纤上传1G的文件,
* 不采用压缩将需要 1024 MB / 12.5MB = 81.92s,如果采用压缩方式上传,压缩所用时间为3秒(当然还需要考虑文件从磁盘读入到内存的时间),压缩后500M,此时文件上传仅需40秒的时间,因此压缩方式上传只需要 3 + 40 = 43秒,
* 同时也大大减少了存储空间,可以说是一举两得。
*
* @code
* Single Thread, Core 2 Duo @3GHz
*
* Name Ratio C.speed D.speed
* LZ4 (r59) 2.084 330 915
* LZO 2.05 1x_1 2.038 311 480
* QuickLZ 1.5-1 2.233 257 277
* Snappy 1.0.5 2.024 227 729
* LZF 2.076 197 465
* FastLZ 2.030 195 420
* zlib 1.2.5 -1 2.728 39 195
* LZ4 HC (r66) 2.712 18 1020
* zlib 1.2.5-6 3.095 14 210
* @endcode
*
* @subsection OSSC采用的压缩格式简介
* @code
* +---+---+---+---+---+---+---+---+
* |"O"|"S"|"S"|"C"| V | A | F | L | "OSSC": Magic Number;
* +---+---+---+---+---+---+---+---+ V: Compressed File Version, Current Version 0x1
* | MD5[00-07] | A: Compression Algorithm, 0x1(LZ4), 0x2(LZO), ...
* +---+---+---+---+---+---+---+---+ F: Flag, 0x1:Integrity Check, ...
* | MD5[08-15] | L: Header Length, Max Value 255
* +---+---+---+---+---+---+---+---+ Optional: Optional Header, Not Used In Version 0x1
* | Optional(4 Bytes) |
* +---+---+---+---+---+---+---+---+--+
* | Block Length | | |
* +---------------+ | \
* | | X(Compressed Data Block 1)
* | Compressed Data | /
* | | |
* +----------------+--------------+--+
* | Block Length | | |
* +----------------+ | \
* | | X(Compressed Data Block 2)
* | Compressed Data | /
* | | |
* +-------------------------------+--+
* | | |
* | Compressed | \
* | Data | X(Compressed Data Block 3 ~ (n - 1))
* | Blocks | /
* | | |
* +-------------------------------+--+
* | Block Length | | |
* +---------------+ | \
* | | X(Compressed Data Block n)
* | Compressed Data | /
* | | |
* +-------------------------------+--+
* @endcode
* @subsection 压缩文件解析
* - OSSC: OSSC压缩文件起始的4个字节是魔数字符串"OSSC",用来识别该文件是否是OSSC的压缩文件格式
* - V: Version,1个字节,压缩文件格式的版本号,目前为0x1
* - A: Algorithm,1个字节,标识压缩文件采用的算法,目前支持LZ4,LZO两种
* - F: Flag,1个字节,标志位,取值为0x1时需要计算原始数据的MD5,同时在解压时进行完整性验证,取值为其他时待定
* - L: Length,1个字节,标识头部长度,所以头部最大长度为255字节
* - MD5: 原始数据的MD5值,在解压缩时进行完整性校验
* - Optional: 可选数据项,目前版本0x1该项没有被利用
*/
/** @page OSSC_EXTRA OSSC高级模块Extra库
* @section OSSC高级模块Extra简介
* OSSC 高级模块中包含了多线程上传大文件的 API,并支持断点续传,我们目前并没有实现 Windows 平台的多线程上传下载功能,以后我们会对此进行改进。
* 另外还支持简单的文件夹上传同步和下载同步的功能,希望该API对其他开发者有用。
*
* OSSC 采用了POSIX多线程标准库 pthread,理论上只要你的操作系统支持 pthread都可以使用 OSSC 的 extra 库中的 API。
*
* @section OSSC_EXTRA_API_INTRO OSSC Extra API 介绍
* OSSC Extra API 提供了有关多线程上传的 API,该 API 支持断点续传
* @code
* extern void
* client_extra_put_object(oss_client_t *client,
* const char *bucket_name,
* const char *key,
* const char *local_file,
* unsigned short *retcode);
* @endcode
* 另外该库里面还包含了文件夹上传同步和下载同步的功能,API如下:
* @code
* //同步上传
* //该函数功能是将dir目录下的所有文件同步到远程bucket_name所标识的Bucket中
* extern int
* oss_sync_upload(oss_client_t * client,
* const char * dir, //本地目录
* const char *bucket_name // 远程Bucket Name
* );
* @endcode
*
* @code
* //同步上传
* //该函数功能是将远程的Bucket中所有文件下载到本地dir目录
* extern int
* oss_sync_download(oss_client_t * client,
* const char *dir,
* const char *bucket_name);
* @endcode
* @section OSSC_EXTRA_API_INTERNAL OSSC Extra API 实现原理
* @subsection 多线程断点续传上传大文件功能实现
* OSSC Extra库提供的另外一个有用的功能是多线程断点续传模式上传大文件,该功能主要利用了OSS的 Multipart Upload来实现。
*
* 首次调用多线程上传功能的函数时,会在当前目录创建一个新的文件夹用来保存上传信息,
* 该文件夹的名称是需要上传文件的起始4096字节的MD5值经过BASE64编码后的字符串(可以确保目录名称唯一性),
* 文件夹内存放了此次上传的Upload ID,以及每个已经成功上传的Part块(8MB)的记录,每个Part的记录方式均采用一个文件来标识,
* 文件名即该Part的PartNumber,内容是该Part的ETag值,如果某次上传网络连接断开,
* 再次启动大文件上传时程序会寻找相应的保存了该文件上传信息的目录,找到Upload ID,扫描Part记录文件,便可以确定哪些Part已经成功上传,
* 然后再用一个位图标识那些成功上传的Part,剩下未上传的Part则在此次启动后被上传,直到整个文件上传完毕。另外,在大文件上传的过程中可以多次中止和启动上传过程,文件上传成功以后,用于保存上传信息的文件夹将被删除。
*
* @attention 在上传过程中请不要删除保存上传信息的文件夹,待文件上传成功后该文件夹会自动删除。
*
* 综上所述,大文件上传的整个流程如下:
*
* -# 首先根据参数提供的本地大文件路径获取该大文件的基本信息,主要是该文件大小,以便计算需要多少个Part;
* -# 初始化线程池,目前线程池中线程数目固定为4;
* -# 检查该文件是否为上次未完成上传的文件(方法:读取文件起始4096字节,计算MD5,获取其BASE64值,查找改目录下是否存在与此文件对应的上传信息目录,如果不存在,则是首次上传,如果存在,则是断点续传);
* -# 如果该文件是首次上传,则新建该文件的上传信息目录,然后初始化一次Multipart Upload,并将upload id保存在该目录中的ID文件中;
* -# 然后由主线程将上传任务放到任务队列中,线程池中的各个线程再从任务队列中取上传任务并执行,注意,为了防止任务过多而消耗过多内存,目前任务队列中任务数目是线程池中线程数目的2倍;
* -# 主线程将所有的任务添加到任务队列后在创建一个新的线程,该线程监视线程池中的线程是否已经完成了所有的上传任务,如果文件已经上传完毕,则由该线程清理掉线程池;
* -# 最后主线程完成上传请求,向OSS发送Complete multipart upload请求,并删除该文件的上传信息目录;
* -# 如果该文件是断点续传,则遍历该文件上传信息目录,找到各个Part记录文件,确定哪些Part已经成功上传;
* -# 对于已经成功上传的文件,在位图中将该Part的位置“1”;
* -# 继续上传未完成的Part,剩下的步骤和第5、6、7步流程相同。
*
* @subsection 简单文件夹同步功能原理
* 目前文件夹同步上传和下载都实现的比较简单,核心思想是对比本地和远程文件的MD5值,避免重复上传和下载,减少数据冗余和网络流量,
* 原理如下:
* @subsubsection 同步上传功能实现
* -# oss_sync_upload首先根据bucket_name参数提供的Bucket名称尝试获取该Bucket的所有对象Object;
* -# 如果远程没有该Bucket,则根据本地目录名称创建一个新的Bucket,然后在将本地文件夹下的所有文件同步到该目录中;
* -# 如果远程存在该Bucket,则获取它的所有对象;
* -# 遍历本地需要同步的文件夹,然后对于每个等待上传的文件,计算其MD5值,如果在远程也存在相同MD5值的对象,则该文件不上传;
* -# 如果远程没有与该文件MD5值相同的对象,则上传该文件。
*
* @subsubsection 同步下载功能实现
* -# oss_sync_download首先根据bucket_name参数提供的Bucket名称尝试获取该Bucket的所有对象Object;
* -# 如果远程没有该Bucket,则直接返回;
* -# 如果远程存在该Bucket,则获取它的所有对象;
* -# 对于远程需要下载的每个文件,获取其MD5值,如果在本地也存在相同MD5值的对象,则该文件不下载;
* -# 如果本地没有与该文件MD5值相同的对象,则下载该文件。
*
*
* @section OSSC_EXTRA_API_USAGE OSSC Extra API使用
* 以下是OSSC Extra 库的使用:
* @subsection 多线程断点上传大文件
* @code
* #include <ossc/client.h>
* #include <ossc/oss_extra.h>
* #include <ossc/oss_helper.h>
*
* static const char *access_id = "ACSGmv8fkV1TDO9L"; //设置用户 Access ID
* static const char *access_key = "BedoWbsJe2"; // 设置用户的 Access Key
* static const char *endpoint = "storage.aliyun.com"; //设置 hostname
*
* // 多线程断点续传,将本地大文件(> 5M)上传至云服务器中
* int main()
* {
* unsigned short retcode = -1;
* const char *retinfo = NULL;
*
* const char *bucket_name = "bucketexample";
* const char *key = "upload-mt.data";
* const char *local_file = "mysql-5.5.27-linux2.6-x86_64.tar.gz";
* //const char *local_file = "mysql-5.1.52.tar.gz";
*
* oss_client_t *client = client_initialize_with_endpoint(access_id, access_key, endpoint);
*
* // 多线程断点续传,将本地大文件上传至云服务器中
* client_extra_put_object(client, bucket_name, key, local_file, &retcode);
*
* if (retcode == OK) {
* printf("put object with multithreaded mode successfully.\n");
* } else {
* retinfo = oss_get_error_message_from_retcode(retcode);
* printf("%s\n", retinfo);
* }
* }
* @endcode
*
* @subsection 文件夹同步上传示例
* @code
* #include <ossc/client.h>
* #include <ossc/oss_extra.h>
* #include <stdio.h>
*
* static const char *access_id = "ACSfLOiddaOzejOP"; //设置用户帐号
* static const char *access_key = "MUltNpuYqE"; //设置用户密码
* static const char *endpoint = "storage.aliyun.com"; //设置hostname
*
* int main()
* {
*
* oss_client_t *client = client_initialize_with_endpoint(access_id, access_key, endpoint);
* const char *bucket_name = "bucket_name_test"; //设置bucket_name
* if(oss_sync_upload(client, "/home/wangwei/Documents/upload_test/", bucket_name) == 0) {
* printf("sync_upload success.\n");
* } else {
* printf("sync_upload failed.\n");
* }
* }
* @endcode
*
* @subsection 文件夹同步下载示例
* @code
* #include <ossc/client.h>
* #include <ossc/oss_extra.h>
* #include <stdio.h>
*
* static const char *access_id = "ACSfLOiddaOzejOP"; //设置用户帐号
* static const char *access_key = "MUltNpuYqE"; //设置用户密码
* static const char *endpoint = "storage.aliyun.com"; //设置hostname
*
* int main()
* {
* oss_client_t *client = client_initialize_with_endpoint(access_id, access_key, endpoint);
* const char *bucket_name = "bucket_name_test"; //设置bucket_name
* if(oss_sync_download(client, "/home/wangwei/Documents/download_test/",bucket_name) == 0) {
* printf("sync_download success.\n");
* } else {
* printf("sync_download failed.\n");
* }
* }
* @endcode
*/
/** @page OSSC_API_EXAMPLE OSSC API 使用示例
* @attention 最新示例代码位于 example 目录中,如果需要测试示例代码,
* 请编译example中的例子(亲,默认已经编译好了,你可以直接去 build/example 的各个子目录中找到可执行文件啦:-))
*
* @section Bucket操作
* @subsection 创建Bucket
* @code
* #include <ossc/client.h>
* #include <stdio.h>
*
* static const char *access_id = "ACSfLOiddaOzejOP"; //设置用户帐号
* static const char *access_key = "MUltNpuYqE"; //设置用户密码
* static const char *endpoint = "storage.aliyun.com"; //设置hostname
*
* //为用户创建一个bucket
* int main()
* {
* unsigned short retcode; //保存服务器http返回码的解析结果;
* const char *retinfo; //保存通过retcode获得的错误信息
*
* oss_client_t *client = client_initialize_with_endpoint(access_id, access_key, endpoint);
* const char *bucket_name = "bucket_example"; //设置bucket_name
*
* client_create_bucket(client, bucket_name, &retcode);
* printf("create_bucket result:\n\n");
* if(retcode == OK) {
* printf("create bucket successfully.\n");
* } else {
* retinfo = oss_get_error_message_from_retcode(retcode);
* printf("error = %s\n", retinfo);
* }
*
* client_finalize(client);
* return 0;
* }
* @endcode
* @subsection 获取Bucket的ACL信息
* @code
*
* #include <ossc/client.h>
* #include <stdio.h>
*
* static const char *access_id = "ACSfLOiddaOzejOP"; //设置用户帐号
* static const char *access_key = "MUltNpuYqE"; //设置用户密码
* static const char *endpoint = "storage.aliyun.com"; //设置hostname
*
* //获得指定bucket的访问权限
* int main()
* {
* unsigned short retcode; //保存服务器http返回码的解析结果
* const char *retinfo; //保存通过retcode获得的错误信息
*
* oss_client_t *client = client_initialize_with_endpoint(access_id, access_key, endpoint);
* const char *bucket_name = "xbucket_example"; //设置bucket_name
*
* oss_access_control_list_t *acl =
* client_get_bucket_acl(client, bucket_name, &retcode);
* oss_owner_t *owner = NULL;
* printf("get_bucket_acl result:\n\n");
* if(retcode == 0) {
* printf("get_bucket_acl successfully.\n");
* owner = acl->get_owner(acl);
* printf("grant = %s\nid = %s\ndisplay_name = %s\n",
* acl->grant,
* owner->id,
* owner->display_name);
* } else {
* retinfo = oss_get_error_message_from_retcode(retcode);
* printf("error = %s\n", retinfo);
* }
* if(owner != NULL) {
* owner_finalize(owner);
* }
* if(acl != NULL) {
* access_control_list_finalize(acl);
* }
*
* client_finalize(client);
* return 0;
* }
* @endcode
* @subsection 设置Bucket的ACL
* @code
* #include <ossc/client.h>
* #include <stdio.h>
*
* static const char *access_id = ""; //设置用户帐号
* static const char *access_key = ""; //设置用户密码
* static const char *endpoint = "storage.aliyun.com"; //设置hostname
*
* //设置指定bucket的访问权限
* int main()
* {
* unsigned short retcode; //保存服务器http返回码的解析结果
* const char *retinfo; //保存通过retcode获得的错误信息
*
* oss_client_t *client = client_initialize_with_endpoint(access_id, access_key, endpoint);
* const char *bucket_name = ""; //设置bucket_name
*
* const char *acl = ""; //设置bucket的访问权限(private,public-read,public-read-write中的一个)
* client_set_bucket_acl(client, bucket_name, acl, &retcode);
* printf("set_bucket_acl result:\n\n");
* if(retcode == 0) {
* printf("set bucket acl successfully.\n");
* } else {
* retinfo = oss_get_error_message_from_retcode(retcode);
* printf("error = %s\n", retinfo);
* }
*
* client_finalize(client);
* return 0;
* }
* @endcode
*
* @subsection 列举Bucket下的Object
* @subsubsection 按名称返回请求者指定Bucket的所有Object
* @code
*
* #include <ossc/client.h>
* #include <stdio.h>
*
* static const char *access_id = "ACSfLOiddaOzejOP"; //设置用户帐号
* static const char *access_key = "MUltNpuYqE"; //设置用户密码
* static const char *endpoint = "storage.aliyun.com"; //设置hostname
*
* //返回请求者指定Bucket下的所有Object的列表
* int main()
* {
* unsigned short retcode; //保存服务器http返回码的解析结果
* const char *retinfo; //保存通过retcode获得的错误信息
*
* int i;
* oss_client_t *client = client_initialize_with_endpoint(access_id, access_key, endpoint);
* const char *bucket_name = "bucket_example";
*
* oss_object_listing_t *object_listing = client_list_objects_with_bucket_name(client, bucket_name, &retcode);
* printf("list_objects_with_bucket_name result:\n\n");
* if(retcode == 0) {
* printf("list_objects_with_bucket_name successfully.\n");
* printf("bucket_name = %s\nnext_marker = %s\nprefix = %s\nmarker = %s\nmax_keys = %d\ndelimiter = %s\nis_truncated = %d\n",
* object_listing->bucket_name, object_listing->next_marker, object_listing->prefix, object_listing->marker,
* object_listing->max_keys, object_listing->delimiter, object_listing->is_truncated);
* for(i = 0; i < object_listing->_counts_summaries; i++) {
* printf("****************************************************************\n");
* printf("object [%d] : \n", i);
* printf("type = %s\netag = %s\nkey = %s\nlast_modified = %s\nsize = %ld\nstorage_class = %s\nid = %s\ndisplay_name = %s\n",
* object_listing->summaries[i]->type, object_listing->summaries[i]->etag,
* object_listing->summaries[i]->key, object_listing->summaries[i]->last_modified,
* object_listing->summaries[i]->size, object_listing->summaries[i]->storage_class,
* object_listing->summaries[i]->owner->id, object_listing->summaries[i]->owner->display_name);
* }
* } else {
* retinfo = oss_get_error_message_from_retcode(retcode);
* printf("error = %s\n", retinfo);
* }
*
* if(object_listing != NULL) {
* if(object_listing->summaries != NULL) {
* for(i = 0; i < object_listing->_counts_summaries; i++) {
* owner_finalize((object_listing->summaries)[i]->owner);
* object_summary_finalize((object_listing->summaries)[i]);
* }
* free(object_listing->summaries);
* }
* object_listing_finalize(object_listing);
* }
*
*
* client_finalize(client);
* return 0;
* }
* @endcode
* @subsubsection 按请求参数返回请求者指定Bucket下的所有Object列表
* @code
* #include <ossc/client.h>
* #include <stdio.h>
*
* static const char *access_id = "ACSfLOiddaOzejOP"; //设置用户帐号
* static const char *access_key = "MUltNpuYqE"; //设置用户密码
* static const char *endpoint = "storage.aliyun.com"; //设置hostname
*
* //返回请求者指定Bucket下的所有Object的列表
* int main()
* {
* unsigned short retcode; //保存服务器http返回码的解析结果
* const char *retinfo; //保存通过retcode获得的错误信息
*
* int i;
* oss_client_t *client = client_initialize_with_endpoint(access_id, access_key, endpoint);
* // 构造 request 参数
* oss_list_objects_request_t *request = list_objects_request_initialize();
* request->set_bucket_name(request, "bucket_example");