knetrs 0.1.1

A TCP library
Documentation 
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

/*
 * Copyright (c) 2014-2016, dennis wang
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef TIMER_API_H
#define TIMER_API_H

#include "config.h"

/**
 * @defgroup timer ��ʱ��
 * ��ʱ��
 *
 * <pre>
 * ��ʱ��
 *
 * ��ʱ����û�з���kloop_t�ڴ����������ṩ�˶�����ktimer_loop_t��������ʱ��.
 * ��3�ֶ�ʱ������:
 *
 * 1. �����Զ�ʱ��     ktimer_start����
 * 2. ����һ�εĶ�ʱ��  ktimer_start_once����
 * 3. ���ж�εĶ�ʱ��  ktimer_start_times����
 *
 * ��ʱ���Ĵ�����ʽͨ���ص��������봫ͳ�Ķ�ʱ��������ʽ��ͬ���ڲ�ʵ�ֲ�����
 * ���������ʱ���ļ����ɾ����ʱ�临�Ӷȶ���O(logn)
 *
 * ktimer_loop_run�ڲ�ʹ�ò���ϵͳ�ṩ�ĺ��뼶˯�ߺ�����ģ��������ֹCPU��ת��
 * ������ϵͳ�ṩ��˯�ߺ���ͨ���Dz�׼ȷ�ģ����˯��>=����ʱ��Ƭ��ͨ�����Ϊ�ٷ�֮2����,
 * ����ڷǺ��뼶��ȷ��ͨ���ǹ��õģ����ǵ���10����ֱ��ʵĶ�ʱ�����зdz�����������Ҫ
 * ��ȷ�Ķ�ʱ������Ҫ���ò���ϵͳ�߷ֱ���ʱ�亯�������д���.
 *
 * </pre>
 * @{
 */

/**
 * ������ʱ��ѭ��
 * @param freq ��С�ֱ��ʣ����룩
 * @return ktimer_loop_tʵ��
 */
extern ktimer_loop_t* ktimer_loop_create(time_t freq);

/**
 * ���ٶ�ʱ��ѭ��
 * @return ktimer_loop_tʵ��
 */
extern void ktimer_loop_destroy(ktimer_loop_t* timer_loop);

/**
 * ��鶨ʱ����ʱ�������ʱ���ö�ʱ���ص�
 * @param timer_loop ktimer_loop_tʵ��
 * @return ��ʱ����ʱ������
 */
extern int ktimer_loop_run_once(ktimer_loop_t* timer_loop);

/**
 * ѭ����鶨ʱ����ʱ������ktimer_loop_exit()�˳�
 * @param timer_loop ktimer_loop_tʵ��
 */
extern void ktimer_loop_run(ktimer_loop_t* timer_loop);

/**
 * �˳�ktimer_loop_run()
 * @param timer_loop ktimer_loop_tʵ��
 */
extern void ktimer_loop_exit(ktimer_loop_t* timer_loop);

/**
 * ����һ����ʱ��
 * @param timer_loop ktimer_loop_tʵ��
 * @return ktimer_tʵ��
 */
extern ktimer_t* ktimer_create(ktimer_loop_t* timer_loop);

/**
 * ֹͣ�����ٶ�ʱ��
 * @param timer ktimer_tʵ��
 * @retval error_ok �ɹ�
 * @retval ���� ʧ��
 */
extern int ktimer_stop(ktimer_t* timer);

/**
 * ȡ��ktimer_loop_tʵ��
 * @param timer ktimer_tʵ��
 * @return ktimer_loop_tʵ��
 */
extern ktimer_loop_t* ktimer_get_loop(ktimer_t* timer);

/**
 * ����һ�����޴����Ķ�ʱ��
 * @param timer ktimer_tʵ��
 * @param cb ��ʱ�ص�����
 * @param data �ص���������
 * @param ms ��ʱ����ʱ���
 * @retval error_ok �ɹ�
 * @retval ���� ʧ��
 */
extern int ktimer_start(ktimer_t* timer, ktimer_cb_t cb, void* data, time_t ms);

/**
 * ����һ��ֻ��ʱһ�εĶ�ʱ������ʱ���Զ�����
 * @param timer ktimer_tʵ��
 * @param cb ��ʱ�ص�����
 * @param data �ص���������
 * @param ms ��ʱ����ʱ���
 * @retval error_ok �ɹ�
 * @retval ���� ʧ��
 */
extern int ktimer_start_once(ktimer_t* timer, ktimer_cb_t cb, void* data, time_t ms);

/**
 * ����һ�����޴����Ķ�ʱ�����ﵽtimes�������Զ�����
 * @param timer ktimer_tʵ��
 * @param cb ��ʱ�ص�����
 * @param data �ص���������
 * @param ms ��ʱ����ʱ���
 * @param times ����
 * @retval error_ok �ɹ�
 * @retval ���� ʧ��
 */
extern int ktimer_start_times(ktimer_t* timer, ktimer_cb_t cb, void* data, time_t ms, int times);

/**
 * ��鶨ʱ���Ƿ��ڻص��������ؼ���������
 * @param timer ktimer_tʵ��
 * @retval 0 ����
 * @retval ���� ��
 */
extern int ktimer_check_dead(ktimer_t* timer);

/**
 * ȡ�õδ���
 * @param timer_loop ktimer_loop_tʵ��
 * @return ���
 */
extern time_t ktimer_loop_get_tick_intval(ktimer_loop_t* timer_loop);

/** @} */

#endif /* TIMER_API_H */