summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--src/lib/ecore_audio/Ecore_Audio.h22
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj.h2
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj_in.h2
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h2
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj_in_tone.h4
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj_out.h2
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj_out_pulse.h2
-rw-r--r--src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h2
-rw-r--r--src/lib/ecore_avahi/Ecore_Avahi.h10
-rw-r--r--src/lib/ecore_buffer/Ecore_Buffer.h40
-rw-r--r--src/lib/ecore_buffer/Ecore_Buffer_Queue.h60
-rw-r--r--src/lib/ecore_con/Ecore_Con.h440
-rw-r--r--src/lib/ecore_con/Ecore_Con_Eet.h46
13 files changed, 317 insertions, 317 deletions
diff --git a/src/lib/ecore_audio/Ecore_Audio.h b/src/lib/ecore_audio/Ecore_Audio.h
index 2f18b24838..af58822c59 100644
--- a/src/lib/ecore_audio/Ecore_Audio.h
+++ b/src/lib/ecore_audio/Ecore_Audio.h
@@ -20,7 +20,7 @@
20 20
21/** 21/**
22 * @file Ecore_Audio.h 22 * @file Ecore_Audio.h
23 * @brief Audio utility functions 23 * @brief Audio utility functions.
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
@@ -69,7 +69,7 @@ typedef struct _Ecore_Audio_Object Ecore_Audio_Object; /**< The audio object */
69 */ 69 */
70struct _Ecore_Audio_Vio { 70struct _Ecore_Audio_Vio {
71 /** 71 /**
72 * @brief Get the length of the file 72 * @brief Gets the length of the file.
73 * 73 *
74 * @param data User data from the ecore_audio_obj_set_vio call 74 * @param data User data from the ecore_audio_obj_set_vio call
75 * @param eo_obj The Ecore_Audio object this operates on 75 * @param eo_obj The Ecore_Audio object this operates on
@@ -81,7 +81,7 @@ struct _Ecore_Audio_Vio {
81 int (*get_length)(void *data, Eo *eo_obj); 81 int (*get_length)(void *data, Eo *eo_obj);
82 82
83 /** 83 /**
84 * @brief Seek to a position within the file 84 * @brief Seeks to a position within the file.
85 * 85 *
86 * @param data User data from the ecore_audio_obj_set_vio call 86 * @param data User data from the ecore_audio_obj_set_vio call
87 * @param eo_obj The Ecore_Audio object this operates on 87 * @param eo_obj The Ecore_Audio object this operates on
@@ -99,7 +99,7 @@ struct _Ecore_Audio_Vio {
99 int (*seek)(void *data, Eo *eo_obj, int offset, int whence); 99 int (*seek)(void *data, Eo *eo_obj, int offset, int whence);
100 100
101 /** 101 /**
102 * @brief Get the current position within the file 102 * @brief Gets the current position within the file.
103 * 103 *
104 * @param data User data from the ecore_audio_obj_set_vio call 104 * @param data User data from the ecore_audio_obj_set_vio call
105 * @param eo_obj The Ecore_Audio object this operates on 105 * @param eo_obj The Ecore_Audio object this operates on
@@ -113,7 +113,7 @@ struct _Ecore_Audio_Vio {
113 int (*tell)(void *data, Eo *eo_obj); 113 int (*tell)(void *data, Eo *eo_obj);
114 114
115 /** 115 /**
116 * @brief Read some data from the file 116 * @brief Reads some data from the file.
117 * 117 *
118 * @param data User data from the ecore_audio_obj_set_vio call 118 * @param data User data from the ecore_audio_obj_set_vio call
119 * @param eo_obj The Ecore_Audio object this operates on 119 * @param eo_obj The Ecore_Audio object this operates on
@@ -127,7 +127,7 @@ struct _Ecore_Audio_Vio {
127 int (*read)(void *data, Eo *eo_obj, void *buffer, int length); 127 int (*read)(void *data, Eo *eo_obj, void *buffer, int length);
128 128
129 /** 129 /**
130 * @brief Write some data to the file 130 * @brief Writes some data to the file.
131 * 131 *
132 * @param data User data from the ecore_audio_obj_set_vio call 132 * @param data User data from the ecore_audio_obj_set_vio call
133 * @param eo_obj The Ecore_Audio object this operates on 133 * @param eo_obj The Ecore_Audio object this operates on
@@ -142,7 +142,7 @@ struct _Ecore_Audio_Vio {
142}; 142};
143 143
144/** 144/**
145 * @brief Holds the callback functions to implement virtual file IO 145 * @brief Holds the callback functions to implement virtual file IO.
146 * @since 1.8 146 * @since 1.8
147 */ 147 */
148typedef struct _Ecore_Audio_Vio Ecore_Audio_Vio; 148typedef struct _Ecore_Audio_Vio Ecore_Audio_Vio;
@@ -150,9 +150,9 @@ typedef struct _Ecore_Audio_Vio Ecore_Audio_Vio;
150/* Audio operations */ 150/* Audio operations */
151 151
152/** 152/**
153 * @brief Initialize the Ecore_Audio library. 153 * @brief Initializes the Ecore_Audio library.
154 * 154 *
155 * @return 1 or greater on success, 0 on error. 155 * @return @c 1 or greater on success, @c 0 on error.
156 * 156 *
157 * @since 1.8 157 * @since 1.8
158 * 158 *
@@ -166,9 +166,9 @@ typedef struct _Ecore_Audio_Vio Ecore_Audio_Vio;
166EAPI int ecore_audio_init(void); 166EAPI int ecore_audio_init(void);
167 167
168/** 168/**
169 * @brief Shut down the Ecore_Audio library. 169 * @brief Shuts down the Ecore_Audio library.
170 * 170 *
171 * @return 0 when the library is completely shut down, 1 or 171 * @return @c 0 when the library is completely shut down, @c 1 or
172 * greater otherwise. 172 * greater otherwise.
173 * 173 *
174 * @since 1.8 174 * @since 1.8
diff --git a/src/lib/ecore_audio/ecore_audio_obj.h b/src/lib/ecore_audio/ecore_audio_obj.h
index ad5062b8e3..55acca21d0 100644
--- a/src/lib/ecore_audio/ecore_audio_obj.h
+++ b/src/lib/ecore_audio/ecore_audio_obj.h
@@ -20,7 +20,7 @@
20 20
21/** 21/**
22 * @file ecore_audio_obj.h 22 * @file ecore_audio_obj.h
23 * @brief Base Ecore_Audio object 23 * @brief Base Ecore_Audio object.
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
diff --git a/src/lib/ecore_audio/ecore_audio_obj_in.h b/src/lib/ecore_audio/ecore_audio_obj_in.h
index 9840de887b..003d5f7748 100644
--- a/src/lib/ecore_audio/ecore_audio_obj_in.h
+++ b/src/lib/ecore_audio/ecore_audio_obj_in.h
@@ -20,7 +20,7 @@
20 20
21/** 21/**
22 * @file ecore_audio_obj_in.h 22 * @file ecore_audio_obj_in.h
23 * @brief Ecore_Audio Input Object 23 * @brief Ecore_Audio Input Object.
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
diff --git a/src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h b/src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h
index fb37b7ccc6..cbd7769ce3 100644
--- a/src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h
+++ b/src/lib/ecore_audio/ecore_audio_obj_in_sndfile.h
@@ -20,7 +20,7 @@
20 20
21/** 21/**
22 * @file ecore_audio_obj_in_sndfile.h 22 * @file ecore_audio_obj_in_sndfile.h
23 * @brief Ecore_Audio sndfile input 23 * @brief Ecore_Audio sndfile input.
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
diff --git a/src/lib/ecore_audio/ecore_audio_obj_in_tone.h b/src/lib/ecore_audio/ecore_audio_obj_in_tone.h
index c7bb60061b..e25a331de0 100644
--- a/src/lib/ecore_audio/ecore_audio_obj_in_tone.h
+++ b/src/lib/ecore_audio/ecore_audio_obj_in_tone.h
@@ -20,7 +20,7 @@
20 20
21/** 21/**
22 * @file ecore_audio_obj_in_tone.h 22 * @file ecore_audio_obj_in_tone.h
23 * @brief Ecore_Audio tone input 23 * @brief Ecore_Audio tone input.
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
@@ -35,7 +35,7 @@ extern "C"
35 */ 35 */
36 36
37/** 37/**
38 * @brief The frequency of the tone in Hz 38 * @brief The frequency of the tone in Hz.
39 * 39 *
40 * Set with @ref efl_key_data_set() 40 * Set with @ref efl_key_data_set()
41 */ 41 */
diff --git a/src/lib/ecore_audio/ecore_audio_obj_out.h b/src/lib/ecore_audio/ecore_audio_obj_out.h
index e8d0819028..5433a7f9ea 100644
--- a/src/lib/ecore_audio/ecore_audio_obj_out.h
+++ b/src/lib/ecore_audio/ecore_audio_obj_out.h
@@ -20,7 +20,7 @@
20 20
21/** 21/**
22 * @file ecore_audio_obj_out.h 22 * @file ecore_audio_obj_out.h
23 * @brief Ecore_Audio output object 23 * @brief Ecore_Audio output object.
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
diff --git a/src/lib/ecore_audio/ecore_audio_obj_out_pulse.h b/src/lib/ecore_audio/ecore_audio_obj_out_pulse.h
index 0e8ad1b5db..ec0ac15beb 100644
--- a/src/lib/ecore_audio/ecore_audio_obj_out_pulse.h
+++ b/src/lib/ecore_audio/ecore_audio_obj_out_pulse.h
@@ -20,7 +20,7 @@
20 20
21/** 21/**
22 * @file ecore_audio_obj_out_pulse.h 22 * @file ecore_audio_obj_out_pulse.h
23 * @brief Ecore_Audio pulseaudio output 23 * @brief Ecore_Audio pulseaudio output.
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
diff --git a/src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h b/src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h
index 0740cfc82b..f2b807dfee 100644
--- a/src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h
+++ b/src/lib/ecore_audio/ecore_audio_obj_out_sndfile.h
@@ -20,7 +20,7 @@
20 20
21/** 21/**
22 * @file ecore_audio_obj_out_sndfile.h 22 * @file ecore_audio_obj_out_sndfile.h
23 * @brief Ecore_Audio sndfile output 23 * @brief Ecore_Audio sndfile output.
24 */ 24 */
25 25
26#ifdef __cplusplus 26#ifdef __cplusplus
diff --git a/src/lib/ecore_avahi/Ecore_Avahi.h b/src/lib/ecore_avahi/Ecore_Avahi.h
index 460ef805e3..76247dbed7 100644
--- a/src/lib/ecore_avahi/Ecore_Avahi.h
+++ b/src/lib/ecore_avahi/Ecore_Avahi.h
@@ -1,7 +1,7 @@
1/** 1/**
2 @brief Ecore Avahi integration Library Public API Calls 2 @brief Ecore Avahi integration Library Public API Calls.
3 3
4 These routines are used for integrating Avahi with Ecore main loop 4 These routines are used for integrating Avahi with Ecore main loop.
5 */ 5 */
6 6
7#ifndef _ECORE_AVAHI_H 7#ifndef _ECORE_AVAHI_H
@@ -50,7 +50,7 @@ extern "C" {
50typedef struct _Ecore_Avahi Ecore_Avahi; /**< A handle for an Avahi instance. */ 50typedef struct _Ecore_Avahi Ecore_Avahi; /**< A handle for an Avahi instance. */
51 51
52/** 52/**
53 * @brief Create an AvahiPoll context and integrate it within Ecore main loop. 53 * @brief Creates an AvahiPoll context and integrate it within Ecore main loop.
54 * 54 *
55 * @return A handler that reference the AvahiPoll context 55 * @return A handler that reference the AvahiPoll context
56 * @since 1.9 56 * @since 1.9
@@ -58,7 +58,7 @@ typedef struct _Ecore_Avahi Ecore_Avahi; /**< A handle for an Avahi instance. */
58EAPI Ecore_Avahi *ecore_avahi_add(void); 58EAPI Ecore_Avahi *ecore_avahi_add(void);
59 59
60/** 60/**
61 * @brief Delete the specified handler of an AvahiPoll. 61 * @brief Deletes the specified handler of an AvahiPoll.
62 * 62 *
63 * @param handler The actual handler to destroy. 63 * @param handler The actual handler to destroy.
64 * @since 1.9 64 * @since 1.9
@@ -69,7 +69,7 @@ EAPI Ecore_Avahi *ecore_avahi_add(void);
69EAPI void ecore_avahi_del(Ecore_Avahi *handler); 69EAPI void ecore_avahi_del(Ecore_Avahi *handler);
70 70
71/** 71/**
72 * @brief Get the AvahiPoll structure to integrate with Ecore main loop. 72 * @brief Gets the AvahiPoll structure to integrate with Ecore main loop.
73 * 73 *
74 * @param handler The handler to get the AvahiPoll structure from. 74 * @param handler The handler to get the AvahiPoll structure from.
75 * @return return the actual AvahiPoll structure to use with Avahi. 75 * @return return the actual AvahiPoll structure to use with Avahi.
diff --git a/src/lib/ecore_buffer/Ecore_Buffer.h b/src/lib/ecore_buffer/Ecore_Buffer.h
index 74a9b3a48a..c8400e619a 100644
--- a/src/lib/ecore_buffer/Ecore_Buffer.h
+++ b/src/lib/ecore_buffer/Ecore_Buffer.h
@@ -464,7 +464,7 @@ struct _Ecore_Buffer_Backend
464}; 464};
465 465
466/** 466/**
467 * @brief Initialize the Ecore_Buffer system. 467 * @brief Initializes the Ecore_Buffer system.
468 * 468 *
469 * @since 1.15 469 * @since 1.15
470 * 470 *
@@ -474,7 +474,7 @@ struct _Ecore_Buffer_Backend
474 */ 474 */
475EAPI Eina_Bool ecore_buffer_init(void); 475EAPI Eina_Bool ecore_buffer_init(void);
476/** 476/**
477 * @brief Shut down the Ecore_Buffer system. 477 * @brief Shuts down the Ecore_Buffer system.
478 * 478 *
479 * @since 1.15 479 * @since 1.15
480 * 480 *
@@ -502,21 +502,21 @@ EAPI Eina_Bool ecore_buffer_register(Ecore_Buffer_Backend *be);
502 */ 502 */
503EAPI void ecore_buffer_unregister(Ecore_Buffer_Backend *be); 503EAPI void ecore_buffer_unregister(Ecore_Buffer_Backend *be);
504/** 504/**
505 * @brief Creates a new Ecore_Buffer given type 505 * @brief Creates a new Ecore_Buffer given type.
506 * 506 *
507 * @since 1.15 507 * @since 1.15
508 * 508 *
509 * @param[in] engine the name of backend 509 * @param[in] engine The name of backend
510 * @param[in] width width for Ecore_Buffer 510 * @param[in] width Width for Ecore_Buffer
511 * @param[in] height height for Ecore_Buffer 511 * @param[in] height Height for Ecore_Buffer
512 * @param[in] format format for Ecore_Buffer 512 * @param[in] format Format for Ecore_Buffer
513 * @param[in] flags flags for Ecore_Buffer 513 * @param[in] flags Flags for Ecore_Buffer
514 * 514 *
515 * @return Newly allocated Ecore_Buffer instance, NULL otherwise. 515 * @return Newly allocated Ecore_Buffer instance, NULL otherwise.
516 */ 516 */
517EAPI Ecore_Buffer *ecore_buffer_new(const char *engine, unsigned int width, unsigned int height, Ecore_Buffer_Format format, unsigned int flags); 517EAPI Ecore_Buffer *ecore_buffer_new(const char *engine, unsigned int width, unsigned int height, Ecore_Buffer_Format format, unsigned int flags);
518/** 518/**
519 * @brief Free the given Ecore_Buffer. 519 * @brief Frees the given Ecore_Buffer.
520 * 520 *
521 * @since 1.15 521 * @since 1.15
522 * 522 *
@@ -524,7 +524,7 @@ EAPI Ecore_Buffer *ecore_buffer_new(const char *engine, unsigned int width, unsi
524 */ 524 */
525EAPI void ecore_buffer_free(Ecore_Buffer *buf); 525EAPI void ecore_buffer_free(Ecore_Buffer *buf);
526/** 526/**
527 * @brief Set a callback for Ecore_Buffer free events. 527 * @brief Sets a callback for Ecore_Buffer free events.
528 * 528 *
529 * @since 1.15 529 * @since 1.15
530 * 530 *
@@ -539,7 +539,7 @@ EAPI void ecore_buffer_free(Ecore_Buffer *buf);
539 */ 539 */
540EAPI void ecore_buffer_free_callback_add(Ecore_Buffer *buf, Ecore_Buffer_Cb func, void *data); 540EAPI void ecore_buffer_free_callback_add(Ecore_Buffer *buf, Ecore_Buffer_Cb func, void *data);
541/** 541/**
542 * @brief Remove a callback for Ecore_Buffer free events. 542 * @brief Removes a callback for Ecore_Buffer free events.
543 * 543 *
544 * @since 1.15 544 * @since 1.15
545 * 545 *
@@ -559,17 +559,17 @@ EAPI void ecore_buffer_free_callback_remove(Ecore_Buffer *buf, Ecore_Bu
559 */ 559 */
560EAPI void *ecore_buffer_data_get(Ecore_Buffer *buf); 560EAPI void *ecore_buffer_data_get(Ecore_Buffer *buf);
561/** 561/**
562 * @brief Return the Pixmap of given Ecore_Buffer. 562 * @brief Returns the Pixmap of given Ecore_Buffer.
563 * 563 *
564 * @since 1.15 564 * @since 1.15
565 * 565 *
566 * @param[in] buf The Ecore_Buffer 566 * @param[in] buf The Ecore_Buffer
567 * 567 *
568 * @return The Pixmap instance, 0 otherwise. 568 * @return The Pixmap instance, @c 0 otherwise.
569 */ 569 */
570EAPI Ecore_Pixmap ecore_buffer_pixmap_get(Ecore_Buffer *buf); 570EAPI Ecore_Pixmap ecore_buffer_pixmap_get(Ecore_Buffer *buf);
571/** 571/**
572 * @brief Return the tbm surface handle of given Ecore_Buffer. 572 * @brief Returns the tbm surface handle of given Ecore_Buffer.
573 * 573 *
574 * @since 1.15 574 * @since 1.15
575 * 575 *
@@ -582,19 +582,19 @@ EAPI Ecore_Pixmap ecore_buffer_pixmap_get(Ecore_Buffer *buf);
582 */ 582 */
583EAPI void *ecore_buffer_tbm_surface_get(Ecore_Buffer *buf); 583EAPI void *ecore_buffer_tbm_surface_get(Ecore_Buffer *buf);
584/** 584/**
585 * @brief Return size of given Ecore_Buffer. 585 * @brief Returns size of given Ecore_Buffer.
586 * 586 *
587 * @since 1.15 587 * @since 1.15
588 * 588 *
589 * @param[in] buf The Ecore_Buffer 589 * @param[in] buf The Ecore_Buffer
590 * @param[out] width where to return the width value. May be @c NULL. 590 * @param[out] width Where to return the width value. May be @c NULL.
591 * @param[out] height where to return the height value. May be @c NULL. 591 * @param[out] height Where to return the height value. May be @c NULL.
592 * 592 *
593 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise. 593 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
594 */ 594 */
595EAPI Eina_Bool ecore_buffer_size_get(Ecore_Buffer *buf, unsigned int *width, unsigned int *height); 595EAPI Eina_Bool ecore_buffer_size_get(Ecore_Buffer *buf, unsigned int *width, unsigned int *height);
596/** 596/**
597 * @brief Return format of given Ecore_Buffer. 597 * @brief Returns format of given Ecore_Buffer.
598 * 598 *
599 * @since 1.15 599 * @since 1.15
600 * 600 *
@@ -602,11 +602,11 @@ EAPI Eina_Bool ecore_buffer_size_get(Ecore_Buffer *buf, unsigned int *width,
602 * 602 *
603 * @return The format of given Ecore_Buffer. 603 * @return The format of given Ecore_Buffer.
604 * 604 *
605 * return value can be one of those pre-defined value such as ECORE_BUFFER_FORMAT_XRGB8888. 605 * Return value can be one of those pre-defined value such as ECORE_BUFFER_FORMAT_XRGB8888.
606 */ 606 */
607EAPI Ecore_Buffer_Format ecore_buffer_format_get(Ecore_Buffer *buf); 607EAPI Ecore_Buffer_Format ecore_buffer_format_get(Ecore_Buffer *buf);
608/** 608/**
609 * @brief Return flags of given Ecore_Buffer. 609 * @brief Returns the flags of given Ecore_Buffer.
610 * 610 *
611 * @since 1.15 611 * @since 1.15
612 * 612 *
diff --git a/src/lib/ecore_buffer/Ecore_Buffer_Queue.h b/src/lib/ecore_buffer/Ecore_Buffer_Queue.h
index 4bc79ae609..578c7537cb 100644
--- a/src/lib/ecore_buffer/Ecore_Buffer_Queue.h
+++ b/src/lib/ecore_buffer/Ecore_Buffer_Queue.h
@@ -38,9 +38,9 @@ extern "C" {
38 * @defgroup Ecore_Buffer_Queue_Group Ecore Buffer Queue functions 38 * @defgroup Ecore_Buffer_Queue_Group Ecore Buffer Queue functions
39 * @ingroup Ecore_Buffer_Group 39 * @ingroup Ecore_Buffer_Group
40 * 40 *
41 * Ecore Buffer Queue is a queue which conntects processes for sharing 41 * Ecore Buffer Queue is a queue which connects processes for sharing
42 * Ecore_Buffer. 42 * Ecore_Buffer.
43 * one process (related object is Ecore_Buffer_Provider) has rear terminal 43 * One process (related object is Ecore_Buffer_Provider) has rear terminal
44 * position of Ecore_Buffer Queue which can enqueue the Ecore_Buffer, 44 * position of Ecore_Buffer Queue which can enqueue the Ecore_Buffer,
45 * and the other process (related object is Ecore_Buffer_Consumer) has front 45 * and the other process (related object is Ecore_Buffer_Consumer) has front
46 * terminal position of Ecore_Buffer_Queue which can dequeue the Ecore_Buffer. 46 * terminal position of Ecore_Buffer_Queue which can dequeue the Ecore_Buffer.
@@ -69,7 +69,7 @@ extern "C" {
69/** 69/**
70 * @typedef Ecore_Buffer_Return 70 * @typedef Ecore_Buffer_Return
71 * @enum _Ecore_Buffer_Return 71 * @enum _Ecore_Buffer_Return
72 * types for an buffer queue state on provider side. 72 * Types for an buffer queue state on provider side.
73 * @ingroup Ecore_Buffer_Provider_Group 73 * @ingroup Ecore_Buffer_Provider_Group
74 * @see ecore_buffer_provider_buffer_acquire() 74 * @see ecore_buffer_provider_buffer_acquire()
75 * @see ecore_buffer_provider_buffer_acquirable_check() 75 * @see ecore_buffer_provider_buffer_acquirable_check()
@@ -173,23 +173,23 @@ typedef void (*Ecore_Buffer_Provider_Enqueue_Cb) (Ecore_Buffer_Provider *provide
173 */ 173 */
174 174
175/** 175/**
176 * @brief Init the Ecore_Buffer_Queue system. 176 * @brief Inits the Ecore_Buffer_Queue system.
177 * 177 *
178 * @since 1.15 178 * @since 1.15
179 * 179 *
180 * @return How many times the lib has been initialized, 0 indicates failure. 180 * @return How many times the lib has been initialized, @c 0 indicates failure.
181 * 181 *
182 * Set up the connection of Buffer Queue deamon, and Init Ecore_Buffer_Queue libraries. 182 * Set up the connection of Buffer Queue daemon, and Init Ecore_Buffer_Queue libraries.
183 * 183 *
184 * @see ecore_buffer_queue_shutdown() 184 * @see ecore_buffer_queue_shutdown()
185 */ 185 */
186EAPI int ecore_buffer_queue_init(void); 186EAPI int ecore_buffer_queue_init(void);
187/** 187/**
188 * @brief Shut down the Ecore_Buffer_Queue system. 188 * @brief Shuts down the Ecore_Buffer_Queue system.
189 * 189 *
190 * @since 1.15 190 * @since 1.15
191 * 191 *
192 * this closes the connection of Buffer Queue deamon, and Shut down Ecore_Buffer_Queue libraries. 192 * This closes the connection of Buffer Queue daemon, and Shut down Ecore_Buffer_Queue libraries.
193 * 193 *
194 * @see ecore_buffer_queue_init() 194 * @see ecore_buffer_queue_init()
195 */ 195 */
@@ -209,16 +209,16 @@ EAPI int ecore_buffer_queue_shutdown(void);
209 * 209 *
210 * @since 1.15 210 * @since 1.15
211 * 211 *
212 * @param[in] name the name of Buffer_Queue, this is needed by Consumer and Provider to connect each other. 212 * @param[in] name The name of Buffer_Queue, this is needed by Consumer and Provider to connect each other.
213 * @param[in] queue_size size of Queue (If you pass this 0, then default size two(2) is appied) 213 * @param[in] queue_size Size of Queue (If you pass this 0, then default size two(2) is appied)
214 * @param[in] w width of buffer recommeneded to provider. 214 * @param[in] w Width of buffer recommended to provider.
215 * @param[in] h height of buffer recommended to provider. 215 * @param[in] h Height of buffer recommended to provider.
216 * 216 *
217 * @return Ecore_Buffer_Consumer instance or @c NULL if creation failed. 217 * @return Ecore_Buffer_Consumer instance or @c NULL if creation failed.
218 */ 218 */
219EAPI Ecore_Buffer_Consumer *ecore_buffer_consumer_new(const char *name, int32_t queue_size, int32_t w, int32_t h); 219EAPI Ecore_Buffer_Consumer *ecore_buffer_consumer_new(const char *name, int32_t queue_size, int32_t w, int32_t h);
220/** 220/**
221 * @brief Free an Ecore_Buffer_Consumer 221 * @brief Frees an Ecore_Buffer_Consumer.
222 * 222 *
223 * @since 1.15 223 * @since 1.15
224 * 224 *
@@ -228,13 +228,13 @@ EAPI Ecore_Buffer_Consumer *ecore_buffer_consumer_new(const char *name, int32
228 */ 228 */
229EAPI void ecore_buffer_consumer_free(Ecore_Buffer_Consumer *consumer); 229EAPI void ecore_buffer_consumer_free(Ecore_Buffer_Consumer *consumer);
230/** 230/**
231 * @brief Return the latest Ecore_Buffer submitted by provider. 231 * @brief Returns the latest Ecore_Buffer submitted by provider.
232 * 232 *
233 * @since 1.15 233 * @since 1.15
234 * 234 *
235 * @param[in] consumer The Ecore_Buffer_Consumer to request for buffer 235 * @param[in] consumer The Ecore_Buffer_Consumer to request for buffer
236 * 236 *
237 * @return Ecore_Buffer handle or NULL if acquirement failed. 237 * @return Ecore_Buffer handle or @c NULL if acquirement failed.
238 * 238 *
239 * @see ecore_buffer_consumer_buffer_release() 239 * @see ecore_buffer_consumer_buffer_release()
240 * 240 *
@@ -243,7 +243,7 @@ EAPI void ecore_buffer_consumer_free(Ecore_Buffer_Consumer
243 */ 243 */
244EAPI Ecore_Buffer *ecore_buffer_consumer_buffer_dequeue(Ecore_Buffer_Consumer *consumer); 244EAPI Ecore_Buffer *ecore_buffer_consumer_buffer_dequeue(Ecore_Buffer_Consumer *consumer);
245/** 245/**
246 * @brief Release the acquired Ecore_Buffer. 246 * @brief Releases the acquired Ecore_Buffer.
247 * 247 *
248 * @since 1.15 248 * @since 1.15
249 * 249 *
@@ -261,7 +261,7 @@ EAPI Ecore_Buffer *ecore_buffer_consumer_buffer_dequeue(Ecore_Buffer
261 */ 261 */
262EAPI Eina_Bool ecore_buffer_consumer_buffer_release(Ecore_Buffer_Consumer *consumer, Ecore_Buffer *buffer); 262EAPI Eina_Bool ecore_buffer_consumer_buffer_release(Ecore_Buffer_Consumer *consumer, Ecore_Buffer *buffer);
263/** 263/**
264 * @brief Check if Queue of Ecore_Buffer is empty. 264 * @brief Checks if Queue of Ecore_Buffer is empty.
265 * 265 *
266 * @since 1.15 266 * @since 1.15
267 * 267 *
@@ -271,7 +271,7 @@ EAPI Eina_Bool ecore_buffer_consumer_buffer_release(Ecore_Buffer
271 */ 271 */
272EAPI Eina_Bool ecore_buffer_consumer_queue_is_empty(Ecore_Buffer_Consumer *consumer); 272EAPI Eina_Bool ecore_buffer_consumer_queue_is_empty(Ecore_Buffer_Consumer *consumer);
273/** 273/**
274 * @brief Set a callback for provider connection events. 274 * @brief Sets a callback for provider connection events.
275 * 275 *
276 * @since 1.15 276 * @since 1.15
277 * 277 *
@@ -284,7 +284,7 @@ EAPI Eina_Bool ecore_buffer_consumer_queue_is_empty(Ecore_Buffer
284 */ 284 */
285EAPI void ecore_buffer_consumer_provider_add_cb_set(Ecore_Buffer_Consumer *consumer, Ecore_Buffer_Consumer_Provider_Add_Cb func, void *data); 285EAPI void ecore_buffer_consumer_provider_add_cb_set(Ecore_Buffer_Consumer *consumer, Ecore_Buffer_Consumer_Provider_Add_Cb func, void *data);
286/** 286/**
287 * @brief Set a callback for provider disconnection events. 287 * @brief Sets a callback for provider disconnection events.
288 * 288 *
289 * @since 1.15 289 * @since 1.15
290 * 290 *
@@ -297,7 +297,7 @@ EAPI void ecore_buffer_consumer_provider_add_cb_set(Ecore_B
297 */ 297 */
298EAPI void ecore_buffer_consumer_provider_del_cb_set(Ecore_Buffer_Consumer *consumer, Ecore_Buffer_Consumer_Provider_Del_Cb func, void *data); 298EAPI void ecore_buffer_consumer_provider_del_cb_set(Ecore_Buffer_Consumer *consumer, Ecore_Buffer_Consumer_Provider_Del_Cb func, void *data);
299/** 299/**
300 * @brief Set a callback for enqueued buffer events. 300 * @brief Sets a callback for enqueued buffer events.
301 * 301 *
302 * @since 1.15 302 * @since 1.15
303 * 303 *
@@ -308,7 +308,7 @@ EAPI void ecore_buffer_consumer_provider_del_cb_set(Ecore_B
308 * A call to this function will set a callback on an Ecore_Buffer_Consumer, causing 308 * A call to this function will set a callback on an Ecore_Buffer_Consumer, causing
309 * @p func to be called whenever @p consumer has received buffer submitted from provider. 309 * @p func to be called whenever @p consumer has received buffer submitted from provider.
310 * 310 *
311 * You may success acuiqre Ecore_Buffer after this callback called. 311 * You may success acquire Ecore_Buffer after this callback called.
312 */ 312 */
313EAPI void ecore_buffer_consumer_buffer_enqueued_cb_set(Ecore_Buffer_Consumer *consumer, Ecore_Buffer_Consumer_Enqueue_Cb func, void *data); 313EAPI void ecore_buffer_consumer_buffer_enqueued_cb_set(Ecore_Buffer_Consumer *consumer, Ecore_Buffer_Consumer_Enqueue_Cb func, void *data);
314 314
@@ -326,13 +326,13 @@ EAPI void ecore_buffer_consumer_buffer_enqueued_cb_set(Ecor
326 * 326 *
327 * @since 1.15 327 * @since 1.15
328 * 328 *
329 * @param[in] name the name of Buffer_Queue. 329 * @param[in] name The name of Buffer_Queue.
330 * 330 *
331 * @return Ecore_Buffer_Provider instance or @c NULL if creation failed. 331 * @return Ecore_Buffer_Provider instance or @c NULL if creation failed.
332 */ 332 */
333EAPI Ecore_Buffer_Provider *ecore_buffer_provider_new(const char *name); 333EAPI Ecore_Buffer_Provider *ecore_buffer_provider_new(const char *name);
334/** 334/**
335 * @brief Free an Ecore_Buffer_Provider 335 * @brief Frees an Ecore_Buffer_Provider.
336 * 336 *
337 * @since 1.15 337 * @since 1.15
338 * 338 *
@@ -342,14 +342,14 @@ EAPI Ecore_Buffer_Provider *ecore_buffer_provider_new(const char *name);
342 */ 342 */
343EAPI void ecore_buffer_provider_free(Ecore_Buffer_Provider *provider); 343EAPI void ecore_buffer_provider_free(Ecore_Buffer_Provider *provider);
344/** 344/**
345 * @brief Return the Ecore_Buffer released by consumer or State of Queue. 345 * @brief Returns the Ecore_Buffer released by consumer or State of Queue.
346 * 346 *
347 * @since 1.15 347 * @since 1.15
348 * 348 *
349 * @param[in] provider The Ecore_Buffer_Provider to request for buffer 349 * @param[in] provider The Ecore_Buffer_Provider to request for buffer
350 * @param[out] ret_buf A Pointer to the Ecore_Buffer 350 * @param[out] ret_buf A Pointer to the Ecore_Buffer
351 * 351 *
352 * @return The enumeration of Ecore_Buffer_Return to indicate result of Dequeueing. 352 * @return The enumeration of Ecore_Buffer_Return to indicate result of Dequeuing.
353 * 353 *
354 * This function gives you drawable buffer and inform you the state of Queue. 354 * This function gives you drawable buffer and inform you the state of Queue.
355 * Each return value of enumeration has meaning as below. 355 * Each return value of enumeration has meaning as below.
@@ -364,7 +364,7 @@ EAPI void ecore_buffer_provider_free(Ecore_Buffer_Provider
364 */ 364 */
365EAPI Ecore_Buffer_Return ecore_buffer_provider_buffer_acquire(Ecore_Buffer_Provider *provider, Ecore_Buffer **ret_buf); 365EAPI Ecore_Buffer_Return ecore_buffer_provider_buffer_acquire(Ecore_Buffer_Provider *provider, Ecore_Buffer **ret_buf);
366/** 366/**
367 * @brief Submit the Ecore_Buffer to Consumer to request compositing. 367 * @brief Submits the Ecore_Buffer to Consumer to request compositing.
368 * 368 *
369 * @since 1.15 369 * @since 1.15
370 * 370 *
@@ -381,7 +381,7 @@ EAPI Ecore_Buffer_Return ecore_buffer_provider_buffer_acquire(Ecore_Buffer
381 */ 381 */
382EAPI Eina_Bool ecore_buffer_provider_buffer_enqueue(Ecore_Buffer_Provider *provider, Ecore_Buffer *buffer); 382EAPI Eina_Bool ecore_buffer_provider_buffer_enqueue(Ecore_Buffer_Provider *provider, Ecore_Buffer *buffer);
383/** 383/**
384 * @brief Check if state of queue. 384 * @brief Checks if state of queue.
385 * 385 *
386 * @since 1.15 386 * @since 1.15
387 * 387 *
@@ -397,7 +397,7 @@ EAPI Eina_Bool ecore_buffer_provider_buffer_enqueue(Ecore_Buffer
397 */ 397 */
398EAPI Ecore_Buffer_Return ecore_buffer_provider_buffer_acquirable_check(Ecore_Buffer_Provider *provider); 398EAPI Ecore_Buffer_Return ecore_buffer_provider_buffer_acquirable_check(Ecore_Buffer_Provider *provider);
399/** 399/**
400 * @brief Set a callback for consumer connection events. 400 * @brief Sets a callback for consumer connection events.
401 * 401 *
402 * @since 1.15 402 * @since 1.15
403 * 403 *
@@ -410,7 +410,7 @@ EAPI Ecore_Buffer_Return ecore_buffer_provider_buffer_acquirable_check(Eco
410 */ 410 */
411EAPI void ecore_buffer_provider_consumer_add_cb_set(Ecore_Buffer_Provider *provider, Ecore_Buffer_Provider_Consumer_Add_Cb func, void *data); 411EAPI void ecore_buffer_provider_consumer_add_cb_set(Ecore_Buffer_Provider *provider, Ecore_Buffer_Provider_Consumer_Add_Cb func, void *data);
412/** 412/**
413 * @brief Set a callback for consumer disconnection events. 413 * @brief Sets a callback for consumer disconnection events.
414 * 414 *
415 * @since 1.15 415 * @since 1.15
416 * 416 *
@@ -423,7 +423,7 @@ EAPI void ecore_buffer_provider_consumer_add_cb_set(Ecore_B
423 */ 423 */
424EAPI void ecore_buffer_provider_consumer_del_cb_set(Ecore_Buffer_Provider *provider, Ecore_Buffer_Provider_Consumer_Del_Cb func, void *data); 424EAPI void ecore_buffer_provider_consumer_del_cb_set(Ecore_Buffer_Provider *provider, Ecore_Buffer_Provider_Consumer_Del_Cb func, void *data);
425/** 425/**
426 * @brief Set a callback for released buffer events. 426 * @brief Sets a callback for released buffer events.
427 * 427 *
428 * @since 1.15 428 * @since 1.15
429 * 429 *
diff --git a/src/lib/ecore_con/Ecore_Con.h b/src/lib/ecore_con/Ecore_Con.h
index e8592f9580..699315115b 100644
--- a/src/lib/ecore_con/Ecore_Con.h
+++ b/src/lib/ecore_con/Ecore_Con.h
@@ -56,7 +56,7 @@
56 * To create a listening server call @c ecore_con_server_add(), optionally using 56 * To create a listening server call @c ecore_con_server_add(), optionally using
57 * an ECORE_CON_USE_* encryption type OR'ed with the type for encryption. 57 * an ECORE_CON_USE_* encryption type OR'ed with the type for encryption.
58 * 58 *
59 * To connect to a server, call @c ecore_con_server_connect(). Data can 59 * To connect to a server, call @c ecore_con_server_connect(). Data can
60 * then be sent to the server using the @c ecore_con_server_send(). 60 * then be sent to the server using the @c ecore_con_server_send().
61 * 61 *
62 * Functions are described in the following groupings: 62 * Functions are described in the following groupings:
@@ -81,15 +81,15 @@
81 * retrieval of the client's ip with @ref ecore_con_client_ip_get and 81 * retrieval of the client's ip with @ref ecore_con_client_ip_get and
82 * associating data with the client using ecore_con_client_data_set. 82 * associating data with the client using ecore_con_client_data_set.
83 * @li ECORE_CON_EVENT_CLIENT_DEL: Whenever a client connection to an 83 * @li ECORE_CON_EVENT_CLIENT_DEL: Whenever a client connection to an
84 * @c Ecore_Con_Server is destroyed, an event of this type is emitted. The contents of 84 * @c Ecore_Con_Server is destroyed, an event of this type is emitted. The contents of
85 * the data with this event are variable, but if the client object in the data 85 * the data with this event are variable, but if the client object in the data
86 * is non-null, it must be freed with @ref ecore_con_client_del. 86 * is non-null, it must be freed with @ref ecore_con_client_del.
87 * @li ECORE_CON_EVENT_CLIENT_DATA: Whenever a server object receives 87 * @li ECORE_CON_EVENT_CLIENT_DATA: Whenever a server object receives
88 * data, then an event of this type is emitted. The data will contain 88 * data, then an event of this type is emitted. The data will contain
89 * the size and contents of the message sent by the client. It should be noted that 89 * the size and contents of the message sent by the client. It should be noted that
90 * data within this object is transient, so it must be duplicated in order to be 90 * data within this object is transient, so it must be duplicated in order to be
91 * retained. This event will continue to occur until the client has stopped sending its 91 * retained. This event will continue to occur until the client has stopped sending its
92 * message, so a good option for storing this data is an Eina_Strbuf. Once the message has 92 * message, so a good option for storing this data is an Eina_Strbuf. Once the message has
93 * been received in full, the client object must be freed with ecore_con_client_free. 93 * been received in full, the client object must be freed with ecore_con_client_free.
94 * 94 *
95 * Client side events: 95 * Client side events:
@@ -100,15 +100,15 @@
100 * occurred. 100 * occurred.
101 * @li ECORE_CON_EVENT_SERVER_DEL: Whenever a server object is destroyed, 101 * @li ECORE_CON_EVENT_SERVER_DEL: Whenever a server object is destroyed,
102 * usually by the server connection being refused or dropped, an event of this 102 * usually by the server connection being refused or dropped, an event of this
103 * type is emitted. The contents of the data with this event are variable, 103 * type is emitted. The contents of the data with this event are variable,
104 * but if the server object in the data is non-null, it must be freed 104 * but if the server object in the data is non-null, it must be freed
105 * with @ref ecore_con_server_del. 105 * with @ref ecore_con_server_del.
106 * @li ECORE_CON_EVENT_SERVER_DATA: Whenever client object receives 106 * @li ECORE_CON_EVENT_SERVER_DATA: Whenever client object receives
107 * data from the server, an event of this type is emitted. The data will contain both 107 * data from the server, an event of this type is emitted. The data will contain both
108 * the size and contents of the message sent by the server. It should be noted that 108 * the size and contents of the message sent by the server. It should be noted that
109 * data within this object is transient, so it must be duplicated in order to be 109 * data within this object is transient, so it must be duplicated in order to be
110 * retained. This event will continue to occur until the server has stopped sending its 110 * retained. This event will continue to occur until the server has stopped sending its
111 * message, so a good option for storing this data is an Eina_Strbuf. Once the message has 111 * message, so a good option for storing this data is an Eina_Strbuf. Once the message has
112 * been received in full, the server object must be freed with ecore_con_server_free. 112 * been received in full, the server object must be freed with ecore_con_server_free.
113 * 113 *
114 */ 114 */
@@ -354,113 +354,113 @@ typedef struct _Ecore_Con_Url Ecore_Con_Url;
354 354
355/** 355/**
356 * @typedef Ecore_Con_Event_Client_Add 356 * @typedef Ecore_Con_Event_Client_Add
357 * Used as the @p data param for the corresponding event 357 * Used as the @p data param for the corresponding event.
358 */ 358 */
359typedef struct _Ecore_Con_Event_Client_Add Ecore_Con_Event_Client_Add; 359typedef struct _Ecore_Con_Event_Client_Add Ecore_Con_Event_Client_Add;
360 360
361/** 361/**
362 * @typedef Ecore_Con_Event_Client_Upgrade 362 * @typedef Ecore_Con_Event_Client_Upgrade
363 * Used as the @p data param for the corresponding event 363 * Used as the @p data param for the corresponding event.
364 * @since 1.1 364 * @since 1.1
365 */ 365 */
366typedef struct _Ecore_Con_Event_Client_Upgrade Ecore_Con_Event_Client_Upgrade; 366typedef struct _Ecore_Con_Event_Client_Upgrade Ecore_Con_Event_Client_Upgrade;
367 367
368/** 368/**
369 * @typedef Ecore_Con_Event_Client_Del 369 * @typedef Ecore_Con_Event_Client_Del
370 * Used as the @p data param for the corresponding event 370 * Used as the @p data param for the corresponding event.
371 */ 371 */
372typedef struct _Ecore_Con_Event_Client_Del Ecore_Con_Event_Client_Del; 372typedef struct _Ecore_Con_Event_Client_Del Ecore_Con_Event_Client_Del;
373 373
374/** 374/**
375 * @typedef Ecore_Con_Event_Client_Error 375 * @typedef Ecore_Con_Event_Client_Error
376 * Used as the @p data param for the corresponding event 376 * Used as the @p data param for the corresponding event.
377 * @since 1.1 377 * @since 1.1
378 */ 378 */
379typedef struct _Ecore_Con_Event_Client_Error Ecore_Con_Event_Client_Error; 379typedef struct _Ecore_Con_Event_Client_Error Ecore_Con_Event_Client_Error;
380 380
381/** 381/**
382 * @typedef Ecore_Con_Event_Server_Add 382 * @typedef Ecore_Con_Event_Server_Add
383 * Used as the @p data param for the corresponding event 383 * Used as the @p data param for the corresponding event.
384 */ 384 */
385typedef struct _Ecore_Con_Event_Server_Add Ecore_Con_Event_Server_Add; 385typedef struct _Ecore_Con_Event_Server_Add Ecore_Con_Event_Server_Add;
386 386
387/** 387/**
388 * @typedef Ecore_Con_Event_Server_Upgrade 388 * @typedef Ecore_Con_Event_Server_Upgrade
389 * Used as the @p data param for the corresponding event 389 * Used as the @p data param for the corresponding event.
390 * @since 1.1 390 * @since 1.1
391 */ 391 */
392typedef struct _Ecore_Con_Event_Server_Upgrade Ecore_Con_Event_Server_Upgrade; 392typedef struct _Ecore_Con_Event_Server_Upgrade Ecore_Con_Event_Server_Upgrade;
393 393
394/** 394/**
395 * @typedef Ecore_Con_Event_Server_Del 395 * @typedef Ecore_Con_Event_Server_Del
396 * Used as the @p data param for the corresponding event 396 * Used as the @p data param for the corresponding event.
397 */ 397 */
398typedef struct _Ecore_Con_Event_Server_Del Ecore_Con_Event_Server_Del; 398typedef struct _Ecore_Con_Event_Server_Del Ecore_Con_Event_Server_Del;
399 399
400/** 400/**
401 * @typedef Ecore_Con_Event_Server_Error 401 * @typedef Ecore_Con_Event_Server_Error
402 * Used as the @p data param for the corresponding event 402 * Used as the @p data param for the corresponding event.
403 * @since 1.1 403 * @since 1.1
404 */ 404 */
405typedef struct _Ecore_Con_Event_Server_Error Ecore_Con_Event_Server_Error; 405typedef struct _Ecore_Con_Event_Server_Error Ecore_Con_Event_Server_Error;
406 406
407/** 407/**
408 * @typedef Ecore_Con_Event_Client_Data 408 * @typedef Ecore_Con_Event_Client_Data
409 * Used as the @p data param for the corresponding event 409 * Used as the @p data param for the corresponding event.
410 */ 410 */
411typedef struct _Ecore_Con_Event_Client_Data Ecore_Con_Event_Client_Data; 411typedef struct _Ecore_Con_Event_Client_Data Ecore_Con_Event_Client_Data;
412 412
413/** 413/**
414 * @typedef Ecore_Con_Event_Server_Data 414 * @typedef Ecore_Con_Event_Server_Data
415 * Used as the @p data param for the corresponding event 415 * Used as the @p data param for the corresponding event.
416 */ 416 */
417typedef struct _Ecore_Con_Event_Server_Data Ecore_Con_Event_Server_Data; 417typedef struct _Ecore_Con_Event_Server_Data Ecore_Con_Event_Server_Data;
418 418
419/** 419/**
420 * @typedef Ecore_Con_Event_Client_Write 420 * @typedef Ecore_Con_Event_Client_Write
421 * Used as the @p data param for the corresponding event 421 * Used as the @p data param for the corresponding event.
422 * @since 1.1 422 * @since 1.1
423 */ 423 */
424typedef struct _Ecore_Con_Event_Client_Write Ecore_Con_Event_Client_Write; 424typedef struct _Ecore_Con_Event_Client_Write Ecore_Con_Event_Client_Write;
425 425
426/** 426/**
427 * @typedef Ecore_Con_Event_Server_Write 427 * @typedef Ecore_Con_Event_Server_Write
428 * Used as the @p data param for the corresponding event 428 * Used as the @p data param for the corresponding event.
429 * @since 1.1 429 * @since 1.1
430 */ 430 */
431typedef struct _Ecore_Con_Event_Server_Write Ecore_Con_Event_Server_Write; 431typedef struct _Ecore_Con_Event_Server_Write Ecore_Con_Event_Server_Write;
432 432
433/** 433/**
434 * @typedef Ecore_Con_Event_Proxy_Bind 434 * @typedef Ecore_Con_Event_Proxy_Bind
435 * Used as the @p data param for the corresponding event 435 * Used as the @p data param for the corresponding event.
436 * @since 1.2 436 * @since 1.2
437 */ 437 */
438typedef struct _Ecore_Con_Event_Proxy_Bind Ecore_Con_Event_Proxy_Bind; 438typedef struct _Ecore_Con_Event_Proxy_Bind Ecore_Con_Event_Proxy_Bind;
439 439
440/** 440/**
441 * @typedef Ecore_Con_Event_Url_Data 441 * @typedef Ecore_Con_Event_Url_Data
442 * Used as the @p data param for the corresponding event 442 * Used as the @p data param for the corresponding event.
443 * @ingroup Ecore_Con_Url_Group 443 * @ingroup Ecore_Con_Url_Group
444 */ 444 */
445typedef struct _Ecore_Con_Event_Url_Data Ecore_Con_Event_Url_Data; 445typedef struct _Ecore_Con_Event_Url_Data Ecore_Con_Event_Url_Data;
446 446
447/** 447/**
448 * @typedef Ecore_Con_Event_Url_Complete 448 * @typedef Ecore_Con_Event_Url_Complete
449 * Used as the @p data param for the corresponding event 449 * Used as the @p data param for the corresponding event.
450 * @ingroup Ecore_Con_Url_Group 450 * @ingroup Ecore_Con_Url_Group
451 */ 451 */
452typedef struct _Ecore_Con_Event_Url_Complete Ecore_Con_Event_Url_Complete; 452typedef struct _Ecore_Con_Event_Url_Complete Ecore_Con_Event_Url_Complete;
453 453
454/** 454/**
455 * @typedef Ecore_Con_Event_Url_Progress 455 * @typedef Ecore_Con_Event_Url_Progress
456 * Used as the @p data param for the corresponding event 456 * Used as the @p data param for the corresponding event.
457 * @ingroup Ecore_Con_Url_Group 457 * @ingroup Ecore_Con_Url_Group
458 */ 458 */
459typedef struct _Ecore_Con_Event_Url_Progress Ecore_Con_Event_Url_Progress; 459typedef struct _Ecore_Con_Event_Url_Progress Ecore_Con_Event_Url_Progress;
460 460
461/** 461/**
462 * @struct _Ecore_Con_Event_Client_Add 462 * @struct _Ecore_Con_Event_Client_Add
463 * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_ADD event 463 * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_ADD event.
464 */ 464 */
465struct _Ecore_Con_Event_Client_Add 465struct _Ecore_Con_Event_Client_Add
466{ 466{
@@ -469,7 +469,7 @@ struct _Ecore_Con_Event_Client_Add
469 469
470/** 470/**
471 * @struct _Ecore_Con_Event_Client_Upgrade 471 * @struct _Ecore_Con_Event_Client_Upgrade
472 * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_UPGRADE event 472 * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_UPGRADE event.
473 * @since 1.1 473 * @since 1.1
474 */ 474 */
475struct _Ecore_Con_Event_Client_Upgrade 475struct _Ecore_Con_Event_Client_Upgrade
@@ -479,7 +479,7 @@ struct _Ecore_Con_Event_Client_Upgrade
479 479
480/** 480/**
481 * @struct _Ecore_Con_Event_Client_Del 481 * @struct _Ecore_Con_Event_Client_Del
482 * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_DEL event 482 * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_DEL event.
483 */ 483 */
484struct _Ecore_Con_Event_Client_Del 484struct _Ecore_Con_Event_Client_Del
485{ 485{
@@ -488,7 +488,7 @@ struct _Ecore_Con_Event_Client_Del
488 488
489/** 489/**
490 * @struct _Ecore_Con_Event_Client_Error 490 * @struct _Ecore_Con_Event_Client_Error
491 * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_ERROR event 491 * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_ERROR event.
492 */ 492 */
493struct _Ecore_Con_Event_Client_Error 493struct _Ecore_Con_Event_Client_Error
494{ 494{
@@ -498,7 +498,7 @@ struct _Ecore_Con_Event_Client_Error
498 498
499/** 499/**
500 * @struct _Ecore_Con_Event_Server_Add 500 * @struct _Ecore_Con_Event_Server_Add
501 * Used as the @p data param for the @ref ECORE_CON_EVENT_SERVER_ADD event 501 * Used as the @p data param for the @ref ECORE_CON_EVENT_SERVER_ADD event.
502 */ 502 */
503struct _Ecore_Con_Event_Server_Add 503struct _Ecore_Con_Event_Server_Add
504{ 504{
@@ -507,7 +507,7 @@ struct _Ecore_Con_Event_Server_Add
507 507
508/** 508/**
509 * @struct _Ecore_Con_Event_Server_Upgrade 509 * @struct _Ecore_Con_Event_Server_Upgrade
510 * Used as the @p data param for the @ref ECORE_CON_EVENT_SERVER_UPGRADE event 510 * Used as the @p data param for the @ref ECORE_CON_EVENT_SERVER_UPGRADE event.
511 * @since 1.1 511 * @since 1.1
512 */ 512 */
513struct _Ecore_Con_Event_Server_Upgrade 513struct _Ecore_Con_Event_Server_Upgrade
@@ -517,7 +517,7 @@ struct _Ecore_Con_Event_Server_Upgrade
517 517
518/** 518/**
519 * @struct _Ecore_Con_Event_Server_Del 519 * @struct _Ecore_Con_Event_Server_Del
520 * Used as the @p data param for the @ref ECORE_CON_EVENT_SERVER_DEL event 520 * Used as the @p data param for the @ref ECORE_CON_EVENT_SERVER_DEL event.
521 */ 521 */
522struct _Ecore_Con_Event_Server_Del 522struct _Ecore_Con_Event_Server_Del
523{ 523{
@@ -526,7 +526,7 @@ struct _Ecore_Con_Event_Server_Del
526 526
527/** 527/**
528 * @struct _Ecore_Con_Event_Server_Error 528 * @struct _Ecore_Con_Event_Server_Error
529 * Used as the @p data param for the @ref ECORE_CON_EVENT_SERVER_ERROR event 529 * Used as the @p data param for the @ref ECORE_CON_EVENT_SERVER_ERROR event.
530 */ 530 */
531struct _Ecore_Con_Event_Server_Error 531struct _Ecore_Con_Event_Server_Error
532{ 532{
@@ -536,7 +536,7 @@ struct _Ecore_Con_Event_Server_Error
536 536
537/** 537/**
538 * @struct _Ecore_Con_Event_Client_Data 538 * @struct _Ecore_Con_Event_Client_Data
539 * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_DATA event 539 * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_DATA event.
540 */ 540 */
541struct _Ecore_Con_Event_Client_Data 541struct _Ecore_Con_Event_Client_Data
542{ 542{
@@ -558,7 +558,7 @@ struct _Ecore_Con_Event_Server_Data
558 558
559/** 559/**
560 * @struct _Ecore_Con_Event_Client_Write 560 * @struct _Ecore_Con_Event_Client_Write
561 * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_WRITE event 561 * Used as the @p data param for the @ref ECORE_CON_EVENT_CLIENT_WRITE event.
562 */ 562 */
563struct _Ecore_Con_Event_Client_Write 563struct _Ecore_Con_Event_Client_Write
564{ 564{
@@ -578,7 +578,7 @@ struct _Ecore_Con_Event_Server_Write
578 578
579/** 579/**
580 * @struct _Ecore_Con_Event_Proxy_Bind 580 * @struct _Ecore_Con_Event_Proxy_Bind
581 * Used as the @p data param for the @ref ECORE_CON_EVENT_PROXY_BIND event 581 * Used as the @p data param for the @ref ECORE_CON_EVENT_PROXY_BIND event.
582 * @ingroup Ecore_Con_Socks_Group 582 * @ingroup Ecore_Con_Socks_Group
583 * @since 1.2 583 * @since 1.2
584 */ 584 */
@@ -591,7 +591,7 @@ struct _Ecore_Con_Event_Proxy_Bind
591 591
592/** 592/**
593 * @struct _Ecore_Con_Event_Url_Data 593 * @struct _Ecore_Con_Event_Url_Data
594 * Used as the @p data param for the @ref ECORE_CON_EVENT_URL_DATA event 594 * Used as the @p data param for the @ref ECORE_CON_EVENT_URL_DATA event.
595 * @ingroup Ecore_Con_Url_Group 595 * @ingroup Ecore_Con_Url_Group
596 */ 596 */
597struct _Ecore_Con_Event_Url_Data 597struct _Ecore_Con_Event_Url_Data
@@ -603,7 +603,7 @@ struct _Ecore_Con_Event_Url_Data
603 603
604/** 604/**
605 * @struct _Ecore_Con_Event_Url_Complete 605 * @struct _Ecore_Con_Event_Url_Complete
606 * Used as the @p data param for the @ref ECORE_CON_EVENT_URL_COMPLETE event 606 * Used as the @p data param for the @ref ECORE_CON_EVENT_URL_COMPLETE event.
607 * @ingroup Ecore_Con_Url_Group 607 * @ingroup Ecore_Con_Url_Group
608 */ 608 */
609struct _Ecore_Con_Event_Url_Complete 609struct _Ecore_Con_Event_Url_Complete
@@ -614,7 +614,7 @@ struct _Ecore_Con_Event_Url_Complete
614 614
615/** 615/**
616 * @struct _Ecore_Con_Event_Url_Progress 616 * @struct _Ecore_Con_Event_Url_Progress
617 * Used as the @p data param for the @ref ECORE_CON_EVENT_URL_PROGRESS event 617 * Used as the @p data param for the @ref ECORE_CON_EVENT_URL_PROGRESS event.
618 * @ingroup Ecore_Con_Url_Group 618 * @ingroup Ecore_Con_Url_Group
619 */ 619 */
620struct _Ecore_Con_Event_Url_Progress 620struct _Ecore_Con_Event_Url_Progress
@@ -632,51 +632,51 @@ struct _Ecore_Con_Event_Url_Progress
632 } up; /**< upload info */ 632 } up; /**< upload info */
633}; 633};
634 634
635/** A client has connected to the server */ 635/** A client has connected to the server. */
636EAPI extern int ECORE_CON_EVENT_CLIENT_ADD; 636EAPI extern int ECORE_CON_EVENT_CLIENT_ADD;
637/** A client has disconnected from the server */ 637/** A client has disconnected from the server. */
638EAPI extern int ECORE_CON_EVENT_CLIENT_DEL; 638EAPI extern int ECORE_CON_EVENT_CLIENT_DEL;
639/** A client experienced an error 639/** A client experienced an error.
640 * @since 1.1 640 * @since 1.1
641 */ 641 */
642EAPI extern int ECORE_CON_EVENT_CLIENT_ERROR; 642EAPI extern int ECORE_CON_EVENT_CLIENT_ERROR;
643/** A client connection has been upgraded to SSL 643/** A client connection has been upgraded to SSL.
644 * @since 1.1 644 * @since 1.1
645 */ 645 */
646EAPI extern int ECORE_CON_EVENT_CLIENT_UPGRADE; 646EAPI extern int ECORE_CON_EVENT_CLIENT_UPGRADE;
647/** A server was created */ 647/** A server was created. */
648EAPI extern int ECORE_CON_EVENT_SERVER_ADD; 648EAPI extern int ECORE_CON_EVENT_SERVER_ADD;
649/** A server connection was lost */ 649/** A server connection was lost. */
650EAPI extern int ECORE_CON_EVENT_SERVER_DEL; 650EAPI extern int ECORE_CON_EVENT_SERVER_DEL;
651/** A server experienced an error 651/** A server experienced an error.
652 * @since 1.1 652 * @since 1.1
653 */ 653 */
654EAPI extern int ECORE_CON_EVENT_SERVER_ERROR; 654EAPI extern int ECORE_CON_EVENT_SERVER_ERROR;
655/** A server connection has been upgraded to SSL 655/** A server connection has been upgraded to SSL.
656 * @since 1.1 656 * @since 1.1
657 */ 657 */
658EAPI extern int ECORE_CON_EVENT_SERVER_UPGRADE; 658EAPI extern int ECORE_CON_EVENT_SERVER_UPGRADE;
659/** A server connection has sent data to its client 659/** A server connection has sent data to its client.
660 * @since 1.1 660 * @since 1.1
661 */ 661 */
662EAPI extern int ECORE_CON_EVENT_CLIENT_WRITE; 662EAPI extern int ECORE_CON_EVENT_CLIENT_WRITE;
663/** A server connection object has sent data 663/** A server connection object has sent data.
664 * @since 1.1 664 * @since 1.1
665 */ 665 */
666EAPI extern int ECORE_CON_EVENT_SERVER_WRITE; 666EAPI extern int ECORE_CON_EVENT_SERVER_WRITE;
667/** A client connected to the server has sent data */ 667/** A client connected to the server has sent data. */
668EAPI extern int ECORE_CON_EVENT_CLIENT_DATA; 668EAPI extern int ECORE_CON_EVENT_CLIENT_DATA;
669/** A server connection object has data */ 669/** A server connection object has data.*/
670EAPI extern int ECORE_CON_EVENT_SERVER_DATA; 670EAPI extern int ECORE_CON_EVENT_SERVER_DATA;
671/** A server connection has successfully negotiated an ip:port binding 671/** A server connection has successfully negotiated an ip:port binding.
672 * @since 1.2 672 * @since 1.2
673 */ 673 */
674EAPI extern int ECORE_CON_EVENT_PROXY_BIND; 674EAPI extern int ECORE_CON_EVENT_PROXY_BIND;
675/** A URL object has data */ 675/** A URL object has data. */
676EAPI extern int ECORE_CON_EVENT_URL_DATA; 676EAPI extern int ECORE_CON_EVENT_URL_DATA;
677/** A URL object has completed its transfer to and from the server and can be reused */ 677/** A URL object has completed its transfer to and from the server and can be reused. */
678EAPI extern int ECORE_CON_EVENT_URL_COMPLETE; 678EAPI extern int ECORE_CON_EVENT_URL_COMPLETE;
679/** A URL object has made progress in its transfer */ 679/** A URL object has made progress in its transfer. */
680EAPI extern int ECORE_CON_EVENT_URL_PROGRESS; 680EAPI extern int ECORE_CON_EVENT_URL_PROGRESS;
681 681
682/** 682/**
@@ -691,7 +691,7 @@ EAPI extern int ECORE_CON_EVENT_URL_PROGRESS;
691 */ 691 */
692 692
693/** 693/**
694 * @brief Initialise the Ecore_Con library. 694 * @brief Initializes the Ecore_Con library.
695 * @return Number of times the library has been initialised without being 695 * @return Number of times the library has been initialised without being
696 * shut down. 696 * shut down.
697 * 697 *
@@ -701,7 +701,7 @@ EAPI extern int ECORE_CON_EVENT_URL_PROGRESS;
701EAPI int ecore_con_init(void); 701EAPI int ecore_con_init(void);
702 702
703/** 703/**
704 * @brief Shut down the Ecore_Con library. 704 * @brief Shuts down the Ecore_Con library.
705 * @return Number of times the library has been initialised without being 705 * @return Number of times the library has been initialised without being
706 * shut down. 706 * shut down.
707 * @note This function already calls ecore_shutdown() internally, so you don't 707 * @note This function already calls ecore_shutdown() internally, so you don't
@@ -743,15 +743,15 @@ EAPI Eina_Bool ecore_con_lookup(const char *name, Ecore_Con_Dns_Cb done_cb, cons
743 */ 743 */
744 744
745/** 745/**
746 * @brief Return if SSL support is available 746 * @brief Returns if SSL support is available.
747 * @return 1 if SSL is available and provided by gnutls, 747 * @return @c 1 if SSL is available and provided by gnutls,
748 * 2 if SSL is available and provided by openssl, 748 * @c 2 if SSL is available and provided by openssl,
749 * 0 if it is not available. 749 * @c 0 if it is not available.
750 */ 750 */
751EAPI int ecore_con_ssl_available_get(void); 751EAPI int ecore_con_ssl_available_get(void);
752 752
753/** 753/**
754 * @brief Add an ssl certificate for use in ecore_con functions. 754 * @brief Adds an SSL certificate for use in ecore_con functions.
755 * 755 *
756 * Use this function to add a SSL PEM certificate. 756 * Use this function to add a SSL PEM certificate.
757 * Simply specify the cert here to use it in the server object for connecting or listening. 757 * Simply specify the cert here to use it in the server object for connecting or listening.
@@ -763,44 +763,44 @@ EAPI int ecore_con_ssl_available_get(void);
763EAPI Eina_Bool ecore_con_ssl_server_cert_add(Ecore_Con_Server *svr, const char *cert); 763EAPI Eina_Bool ecore_con_ssl_server_cert_add(Ecore_Con_Server *svr, const char *cert);
764 764
765/** 765/**
766 * @brief Add an ssl private key for use in ecore_con functions. 766 * @brief Adds an SSL private key for use in ecore_con functions.
767 * 767 *
768 * Use this function to add a SSL PEM private key 768 * Use this function to add a SSL PEM private key.
769 * Simply specify the key file here to use it in the server object for connecting or listening. 769 * Simply specify the key file here to use it in the server object for connecting or listening.
770 * If there is an error loading the key, an error will automatically be logged. 770 * If there is an error loading the key, an error will automatically be logged.
771 * @param svr The server object 771 * @param svr The server object.
772 * @param key_file The path to the key file. 772 * @param key_file The path to the key file.
773 * @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE. 773 * @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE.
774 */ 774 */
775EAPI Eina_Bool ecore_con_ssl_server_privkey_add(Ecore_Con_Server *svr, const char *key_file); 775EAPI Eina_Bool ecore_con_ssl_server_privkey_add(Ecore_Con_Server *svr, const char *key_file);
776 776
777/** 777/**
778 * @brief Add an ssl CRL for use in ecore_con functions. 778 * @brief Adds an SSL CRL for use in ecore_con functions.
779 * 779 *
780 * Use this function to add a SSL PEM CRL file 780 * Use this function to add a SSL PEM CRL file.
781 * Simply specify the CRL file here to use it in the server object for connecting or listening. 781 * Simply specify the CRL file here to use it in the server object for connecting or listening.
782 * If there is an error loading the CRL, an error will automatically be logged. 782 * If there is an error loading the CRL, an error will automatically be logged.
783 * @param svr The server object 783 * @param svr The server object.
784 * @param crl_file The path to the CRL file. 784 * @param crl_file The path to the CRL file.
785 * @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE. 785 * @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE.
786 */ 786 */
787EAPI Eina_Bool ecore_con_ssl_server_crl_add(Ecore_Con_Server *svr, const char *crl_file); 787EAPI Eina_Bool ecore_con_ssl_server_crl_add(Ecore_Con_Server *svr, const char *crl_file);
788 788
789/** 789/**
790 * @brief Add an ssl CA file for use in ecore_con functions. 790 * @brief Adds an SSL CA file for use in ecore_con functions.
791 * 791 *
792 * Use this function to add a SSL PEM CA file. 792 * Use this function to add a SSL PEM CA file.
793 * Simply specify the file here to use it in the server object for connecting or listening. 793 * Simply specify the file here to use it in the server object for connecting or listening.
794 * If there is an error loading the CAs, an error will automatically be logged. 794 * If there is an error loading the CAs, an error will automatically be logged.
795 * @param svr The server object 795 * @param svr The server object.
796 * @param ca_file The path to the CA file. 796 * @param ca_file The path to the CA file.
797 * @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE. 797 * @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE.
798 * @note since 1.2, this function can load directores 798 * @note since 1.2, this function can load directories.
799 */ 799 */
800EAPI Eina_Bool ecore_con_ssl_server_cafile_add(Ecore_Con_Server *svr, const char *ca_file); 800EAPI Eina_Bool ecore_con_ssl_server_cafile_add(Ecore_Con_Server *svr, const char *ca_file);
801 801
802/** 802/**
803 * @brief Enable certificate verification on a server object 803 * @brief Enables certificate verification on a server object.
804 * 804 *
805 * Call this function on a server object before main loop has started 805 * Call this function on a server object before main loop has started
806 * to enable verification of certificates against loaded certificates. 806 * to enable verification of certificates against loaded certificates.
@@ -809,19 +809,19 @@ EAPI Eina_Bool ecore_con_ssl_server_cafile_add(Ecore_Con_Server *svr, co
809EAPI void ecore_con_ssl_server_verify(Ecore_Con_Server *svr); 809EAPI void ecore_con_ssl_server_verify(Ecore_Con_Server *svr);
810 810
811/** 811/**
812 * @brief Enable hostname-based certificate verification on a server object 812 * @brief Enables hostname-based certificate verification on a server object.
813 * 813 *
814 * Call this function on a server object before main loop has started 814 * Call this function on a server object before main loop has started
815 * to enable verification of certificates using ONLY their hostnames. 815 * to enable verification of certificates using ONLY their hostnames.
816 * @param svr The server object 816 * @param svr The server object.
817 * @note This function has no effect when used on a listening server created by 817 * @note This function has no effect when used on a listening server created by
818 * ecore_con_server_add 818 * ecore_con_server_add.
819 * @since 1.1 819 * @since 1.1
820 */ 820 */
821EAPI void ecore_con_ssl_server_verify_basic(Ecore_Con_Server *svr); 821EAPI void ecore_con_ssl_server_verify_basic(Ecore_Con_Server *svr);
822 822
823/** 823/**
824 * @brief Set the hostname to verify against in certificate verification 824 * @brief Sets the hostname to verify against in certificate verification.
825 * 825 *
826 * Sometimes the certificate hostname will not match the hostname that you are 826 * Sometimes the certificate hostname will not match the hostname that you are
827 * connecting to, and will instead match a different name. An example of this is 827 * connecting to, and will instead match a different name. An example of this is
@@ -829,46 +829,46 @@ EAPI void ecore_con_ssl_server_verify_basic(Ecore_Con_Server *svr);
829 * certificate for gmail.com. This certificate should be trusted, and so you must call 829 * certificate for gmail.com. This certificate should be trusted, and so you must call
830 * this function with "gmail.com" as @p name. 830 * this function with "gmail.com" as @p name.
831 * See RFC2818 for more details. 831 * See RFC2818 for more details.
832 * @param svr The server object 832 * @param svr The server object.
833 * @param name The hostname to verify against 833 * @param name The hostname to verify against
834 * @since 1.2 834 * @since 1.2
835 */ 835 */
836EAPI void ecore_con_ssl_server_verify_name_set(Ecore_Con_Server *svr, const char *name); 836EAPI void ecore_con_ssl_server_verify_name_set(Ecore_Con_Server *svr, const char *name);
837 837
838/** 838/**
839 * @brief Get the hostname to verify against in certificate verification 839 * @brief Gets the hostname to verify against in certificate verification.
840 * 840 *
841 * This function returns the name which will be used to validate the SSL certificate 841 * This function returns the name which will be used to validate the SSL certificate
842 * common name (CN) or alt name (subjectAltName). It will default to the @p name 842 * common name (CN) or alt name (subjectAltName). It will default to the @p name
843 * param in ecore_con_server_connect(), but can be changed with ecore_con_ssl_server_verify_name_set(). 843 * param in ecore_con_server_connect(), but can be changed with ecore_con_ssl_server_verify_name_set().
844 * @param svr The server object 844 * @param svr The server object.
845 * @return The hostname which will be used 845 * @return The hostname which will be used
846 * @since 1.2 846 * @since 1.2
847 */ 847 */
848EAPI const char *ecore_con_ssl_server_verify_name_get(Ecore_Con_Server *svr); 848EAPI const char *ecore_con_ssl_server_verify_name_get(Ecore_Con_Server *svr);
849 849
850/** 850/**
851 * @brief Upgrade a connection to a specified level of encryption 851 * @brief Upgrades a connection to a specified level of encryption.
852 * 852 *
853 * Use this function to begin an SSL handshake on a connection (STARTTLS or similar). 853 * Use this function to begin an SSL handshake on a connection (STARTTLS or similar).
854 * Once the upgrade has been completed, an ECORE_CON_EVENT_SERVER_UPGRADE event will be emitted. 854 * Once the upgrade has been completed, an ECORE_CON_EVENT_SERVER_UPGRADE event will be emitted.
855 * The connection should be treated as disconnected until the next event. 855 * The connection should be treated as disconnected until the next event.
856 * @param svr The server object 856 * @param svr The server object.
857 * @param ssl_type The SSL connection type (ONLY). 857 * @param ssl_type The SSL connection type (ONLY).
858 * @return @c EINA_FALSE if the connection cannot be upgraded, otherwise @c EINA_TRUE. 858 * @return @c EINA_FALSE if the connection cannot be upgraded, otherwise @c EINA_TRUE.
859 * @note This function is NEVER to be used on a server object created with ecore_con_server_add 859 * @note This function is NEVER to be used on a server object created with ecore_con_server_add.
860 * @warning Setting a wrong value for @p compl_type WILL mess up your program. 860 * @warning Setting a wrong value for @p compl_type WILL mess up your program.
861 * @since 1.1 861 * @since 1.1
862 */ 862 */
863EAPI Eina_Bool ecore_con_ssl_server_upgrade(Ecore_Con_Server *svr, Ecore_Con_Type compl_type); 863EAPI Eina_Bool ecore_con_ssl_server_upgrade(Ecore_Con_Server *svr, Ecore_Con_Type compl_type);
864 864
865/** 865/**
866 * @brief Upgrade a connection to a specified level of encryption 866 * @brief Upgrades a connection to a specified level of encryption.
867 * 867 *
868 * Use this function to begin an SSL handshake on a connection (STARTTLS or similar). 868 * Use this function to begin an SSL handshake on a connection (STARTTLS or similar).
869 * Once the upgrade has been completed, an ECORE_CON_EVENT_CLIENT_UPGRADE event will be emitted. 869 * Once the upgrade has been completed, an ECORE_CON_EVENT_CLIENT_UPGRADE event will be emitted.
870 * The connection should be treated as disconnected until the next event. 870 * The connection should be treated as disconnected until the next event.
871 * @param cl The client object 871 * @param cl The client object.
872 * @param ssl_type The SSL connection type (ONLY). 872 * @param ssl_type The SSL connection type (ONLY).
873 * @return @c EINA_FALSE if the connection cannot be upgraded, otherwise @c EINA_TRUE. 873 * @return @c EINA_FALSE if the connection cannot be upgraded, otherwise @c EINA_TRUE.
874 * @warning Setting a wrong value for @p compl_type WILL mess up your program. 874 * @warning Setting a wrong value for @p compl_type WILL mess up your program.
@@ -887,28 +887,28 @@ EAPI Eina_Bool ecore_con_ssl_client_upgrade(Ecore_Con_Client *cl, Ecore_
887 */ 887 */
888 888
889/** 889/**
890 * @brief Add a SOCKS v4 proxy to the proxy list 890 * @brief Adds a SOCKS v4 proxy to the proxy list.
891 * 891 *
892 * Use this to create (or return, if previously added) a SOCKS proxy 892 * Use this to create (or return, if previously added) a SOCKS proxy
893 * object which can be used by any ecore_con servers. 893 * object which can be used by any ecore_con servers.
894 * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.) 894 * @param ip The ip address of the proxy. (NOT DOMAIN NAME. IP ADDRESS.)
895 * @param port The port to connect to on the proxy 895 * @param port The port to connect to on the proxy.
896 * @param username The username to use for the proxy (OPTIONAL) 896 * @param username The username to use for the proxy. (OPTIONAL)
897 * @return An allocated proxy object, or NULL on failure 897 * @return An allocated proxy object, or @c NULL on failure.
898 * @note This object NEVER needs to be explicitly freed. 898 * @note This object NEVER needs to be explicitly freed.
899 * @since 1.2 899 * @since 1.2
900 */ 900 */
901EAPI Ecore_Con_Socks *ecore_con_socks4_remote_add(const char *ip, int port, const char *username); 901EAPI Ecore_Con_Socks *ecore_con_socks4_remote_add(const char *ip, int port, const char *username);
902 902
903/** 903/**
904 * @brief Find a SOCKS v4 proxy in the proxy list 904 * @brief Finds a SOCKS v4 proxy in the proxy list.
905 * 905 *
906 * Use this to determine if a SOCKS proxy was previously added by checking 906 * Use this to determine if a SOCKS proxy was previously added by checking
907 * the proxy list against the parameters given. 907 * the proxy list against the parameters given.
908 * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.) 908 * @param ip The ip address of the proxy. (NOT DOMAIN NAME. IP ADDRESS.)
909 * @param port The port to connect to on the proxy, or -1 to match the first proxy with @p ip 909 * @param port The port to connect to on the proxy, or -1 to match the first proxy with @p ip
910 * @param username The username used for the proxy (OPTIONAL) 910 * @param username The username used for the proxy. (OPTIONAL)
911 * @return true only if a proxy exists matching the given params 911 * @return True only if a proxy exists matching the given params.
912 * @note This function matches slightly more loosely than ecore_con_socks4_remote_add(), and 912 * @note This function matches slightly more loosely than ecore_con_socks4_remote_add(), and
913 * ecore_con_socks4_remote_add() should be used to return the actual object. 913 * ecore_con_socks4_remote_add() should be used to return the actual object.
914 * @since 1.2 914 * @since 1.2
@@ -916,13 +916,13 @@ EAPI Ecore_Con_Socks *ecore_con_socks4_remote_add(const char *ip, int port, cons
916EAPI Eina_Bool ecore_con_socks4_remote_exists(const char *ip, int port, const char *username); 916EAPI Eina_Bool ecore_con_socks4_remote_exists(const char *ip, int port, const char *username);
917 917
918/** 918/**
919 * @brief Remove a SOCKS v4 proxy from the proxy list and delete it 919 * @brief Removes a SOCKS v4 proxy from the proxy list and delete it.
920 * 920 *
921 * Use this to remove a SOCKS proxy from the proxy list by checking 921 * Use this to remove a SOCKS proxy from the proxy list by checking
922 * the list against the parameters given. The proxy will then be deleted. 922 * the list against the parameters given. The proxy will then be deleted.
923 * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.) 923 * @param ip The ip address of the proxy. (NOT DOMAIN NAME. IP ADDRESS.)
924 * @param port The port to connect to on the proxy, or -1 to match the first proxy with @p ip 924 * @param port The port to connect to on the proxy, or -1 to match the first proxy with @p ip
925 * @param username The username used for the proxy (OPTIONAL) 925 * @param username The username used for the proxy. (OPTIONAL)
926 * @note This function matches in the same way as ecore_con_socks4_remote_exists(). 926 * @note This function matches in the same way as ecore_con_socks4_remote_exists().
927 * @warning Be aware that deleting a proxy which is being used WILL ruin your life. 927 * @warning Be aware that deleting a proxy which is being used WILL ruin your life.
928 * @since 1.2 928 * @since 1.2
@@ -930,30 +930,30 @@ EAPI Eina_Bool ecore_con_socks4_remote_exists(const char *ip, int port, c
930EAPI void ecore_con_socks4_remote_del(const char *ip, int port, const char *username); 930EAPI void ecore_con_socks4_remote_del(const char *ip, int port, const char *username);
931 931
932/** 932/**
933 * @brief Add a SOCKS v5 proxy to the proxy list 933 * @brief Adds a SOCKS v5 proxy to the proxy list.
934 * 934 *
935 * Use this to create (or return, if previously added) a SOCKS proxy 935 * Use this to create (or return, if previously added) a SOCKS proxy
936 * object which can be used by any ecore_con servers. 936 * object which can be used by any ecore_con servers.
937 * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.) 937 * @param ip The ip address of the proxy. (NOT DOMAIN NAME. IP ADDRESS.)
938 * @param port The port to connect to on the proxy 938 * @param port The port to connect to on the proxy.
939 * @param username The username to use for the proxy (OPTIONAL) 939 * @param username The username to use for the proxy. (OPTIONAL)
940 * @param password The password to use for the proxy (OPTIONAL) 940 * @param password The password to use for the proxy. (OPTIONAL)
941 * @return An allocated proxy object, or NULL on failure 941 * @return An allocated proxy object, or @c NULL on failure.
942 * @note This object NEVER needs to be explicitly freed. 942 * @note This object NEVER needs to be explicitly freed.
943 * @since 1.2 943 * @since 1.2
944 */ 944 */
945EAPI Ecore_Con_Socks *ecore_con_socks5_remote_add(const char *ip, int port, const char *username, const char *password); 945EAPI Ecore_Con_Socks *ecore_con_socks5_remote_add(const char *ip, int port, const char *username, const char *password);
946 946
947/** 947/**
948 * @brief Find a SOCKS v5 proxy in the proxy list 948 * @brief Finds a SOCKS v5 proxy in the proxy list.
949 * 949 *
950 * Use this to determine if a SOCKS proxy was previously added by checking 950 * Use this to determine if a SOCKS proxy was previously added by checking
951 * the proxy list against the parameters given. 951 * the proxy list against the parameters given.
952 * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.) 952 * @param ip The ip address of the proxy. (NOT DOMAIN NAME. IP ADDRESS.)
953 * @param port The port to connect to on the proxy, or -1 to match the first proxy with @p ip 953 * @param port The port to connect to on the proxy, or -1 to match the first proxy with @p ip
954 * @param username The username used for the proxy (OPTIONAL) 954 * @param username The username used for the proxy. (OPTIONAL)
955 * @param password The password used for the proxy (OPTIONAL) 955 * @param password The password used for the proxy. (OPTIONAL)
956 * @return true only if a proxy exists matching the given params 956 * @return True only if a proxy exists matching the given params.
957 * @note This function matches slightly more loosely than ecore_con_socks5_remote_add(), and 957 * @note This function matches slightly more loosely than ecore_con_socks5_remote_add(), and
958 * ecore_con_socks5_remote_add() should be used to return the actual object. 958 * ecore_con_socks5_remote_add() should be used to return the actual object.
959 * @since 1.2 959 * @since 1.2
@@ -961,14 +961,14 @@ EAPI Ecore_Con_Socks *ecore_con_socks5_remote_add(const char *ip, int port, cons
961EAPI Eina_Bool ecore_con_socks5_remote_exists(const char *ip, int port, const char *username, const char *password); 961EAPI Eina_Bool ecore_con_socks5_remote_exists(const char *ip, int port, const char *username, const char *password);
962 962
963/** 963/**
964 * @brief Remove a SOCKS v5 proxy from the proxy list and delete it 964 * @brief Removes a SOCKS v5 proxy from the proxy list and delete it.
965 * 965 *
966 * Use this to remove a SOCKS proxy from the proxy list by checking 966 * Use this to remove a SOCKS proxy from the proxy list by checking
967 * the list against the parameters given. The proxy will then be deleted. 967 * the list against the parameters given. The proxy will then be deleted.
968 * @param ip The ip address of the proxy (NOT DOMAIN NAME. IP ADDRESS.) 968 * @param ip The ip address of the proxy. (NOT DOMAIN NAME. IP ADDRESS.)
969 * @param port The port to connect to on the proxy, or -1 to match the first proxy with @p ip 969 * @param port The port to connect to on the proxy, or -1 to match the first proxy with @p ip
970 * @param username The username used for the proxy (OPTIONAL) 970 * @param username The username used for the proxy. (OPTIONAL)
971 * @param password The password used for the proxy (OPTIONAL) 971 * @param password The password used for the proxy. (OPTIONAL)
972 * @note This function matches in the same way as ecore_con_socks4_remote_exists(). 972 * @note This function matches in the same way as ecore_con_socks4_remote_exists().
973 * @warning Be aware that deleting a proxy which is being used WILL ruin your life. 973 * @warning Be aware that deleting a proxy which is being used WILL ruin your life.
974 * @since 1.2 974 * @since 1.2
@@ -976,69 +976,69 @@ EAPI Eina_Bool ecore_con_socks5_remote_exists(const char *ip, int port, c
976EAPI void ecore_con_socks5_remote_del(const char *ip, int port, const char *username, const char *password); 976EAPI void ecore_con_socks5_remote_del(const char *ip, int port, const char *username, const char *password);
977 977
978/** 978/**
979 * @brief Set DNS lookup mode on an existing SOCKS proxy 979 * @brief Sets DNS lookup mode on an existing SOCKS proxy.
980 * 980 *
981 * According to RFC, SOCKS v4 does not require that a proxy perform 981 * According to RFC, SOCKS v4 does not require that a proxy perform
982 * its own DNS lookups for addresses. SOCKS v4a specifies the protocol 982 * its own DNS lookups for addresses. SOCKS v4a specifies the protocol
983 * for this. SOCKS v5 allows DNS lookups. 983 * for this. SOCKS v5 allows DNS lookups.
984 * If you want to enable remote DNS lookup and are sure that your 984 * If you want to enable remote DNS lookup and are sure that your
985 * proxy supports it, use this function. 985 * proxy supports it, use this function.
986 * @param ecs The proxy object 986 * @param ecs The proxy object.
987 * @param enable If true, the proxy will perform the dns lookup 987 * @param enable If true, the proxy will perform the dns lookup.
988 * @note By default, this setting is DISABLED. 988 * @note By default, this setting is DISABLED.
989 * @since 1.2 989 * @since 1.2
990 */ 990 */
991EAPI void ecore_con_socks_lookup_set(Ecore_Con_Socks *ecs, Eina_Bool enable); 991EAPI void ecore_con_socks_lookup_set(Ecore_Con_Socks *ecs, Eina_Bool enable);
992 992
993/** 993/**
994 * @brief Get DNS lookup mode on an existing SOCKS proxy 994 * @brief Gets DNS lookup mode on an existing SOCKS proxy.
995 * 995 *
996 * According to RFC, SOCKS v4 does not require that a proxy perform 996 * According to RFC, SOCKS v4 does not require that a proxy perform
997 * its own DNS lookups for addresses. SOCKS v4a specifies the protocol 997 * its own DNS lookups for addresses. SOCKS v4a specifies the protocol
998 * for this. SOCKS v5 allows DNS lookups. 998 * for this. SOCKS v5 allows DNS lookups.
999 * This function returns whether lookups are enabled on a proxy object. 999 * This function returns whether lookups are enabled on a proxy object.
1000 * @param ecs The proxy object 1000 * @param ecs The proxy object.
1001 * @return If true, the proxy will perform the dns lookup 1001 * @return If true, the proxy will perform the dns lookup.
1002 * @note By default, this setting is DISABLED. 1002 * @note By default, this setting is DISABLED.
1003 * @since 1.2 1003 * @since 1.2
1004 */ 1004 */
1005EAPI Eina_Bool ecore_con_socks_lookup_get(Ecore_Con_Socks *ecs); 1005EAPI Eina_Bool ecore_con_socks_lookup_get(Ecore_Con_Socks *ecs);
1006 1006
1007/** 1007/**
1008 * @brief Enable bind mode on a SOCKS proxy 1008 * @brief Enables bind mode on a SOCKS proxy.
1009 * 1009 *
1010 * Use this function to enable binding a remote port for use with a remote server. 1010 * Use this function to enable binding a remote port for use with a remote server.
1011 * For more information, see http://ufasoft.com/doc/socks4_protocol.htm 1011 * For more information, see http://ufasoft.com/doc/socks4_protocol.htm
1012 * @param ecs The proxy object 1012 * @param ecs The proxy object.
1013 * @param is_bind If true, the connection established will be a port binding 1013 * @param is_bind If true, the connection established will be a port binding.
1014 * @warning Be aware that changing the operation mode of an active proxy may result in undefined behavior 1014 * @warning Be aware that changing the operation mode of an active proxy may result in undefined behavior
1015 * @since 1.2 1015 * @since 1.2
1016 */ 1016 */
1017EAPI void ecore_con_socks_bind_set(Ecore_Con_Socks *ecs, Eina_Bool is_bind); 1017EAPI void ecore_con_socks_bind_set(Ecore_Con_Socks *ecs, Eina_Bool is_bind);
1018 1018
1019/** 1019/**
1020 * @brief Return bind mode of a SOCKS proxy 1020 * @brief Returns bind mode of a SOCKS proxy.
1021 * 1021 *
1022 * Use this function to return bind mode of a proxy (binding a remote port for use with a remote server). 1022 * Use this function to return bind mode of a proxy (binding a remote port for use with a remote server).
1023 * For more information, see http://ufasoft.com/doc/socks4_protocol.htm 1023 * For more information, see http://ufasoft.com/doc/socks4_protocol.htm
1024 * @param ecs The proxy object 1024 * @param ecs The proxy object.
1025 * @return If true, the connection established will be a port binding 1025 * @return If true, the connection established will be a port binding.
1026 * @since 1.2 1026 * @since 1.2
1027 */ 1027 */
1028EAPI Eina_Bool ecore_con_socks_bind_get(Ecore_Con_Socks *ecs); 1028EAPI Eina_Bool ecore_con_socks_bind_get(Ecore_Con_Socks *ecs);
1029 1029
1030/** 1030/**
1031 * @brief Return SOCKS version of a SOCKS proxy 1031 * @brief Returns SOCKS version of a SOCKS proxy.
1032 * 1032 *
1033 * Use this function to return the SOCKS protocol version of a proxy 1033 * Use this function to return the SOCKS protocol version of a proxy.
1034 * @param ecs The proxy object 1034 * @param ecs The proxy object.
1035 * @return 0 on error, else 4/5 1035 * @return @c 0 on error, else @c 4/5
1036 * @since 1.2 1036 * @since 1.2
1037 */ 1037 */
1038EAPI unsigned int ecore_con_socks_version_get(Ecore_Con_Socks *ecs); 1038EAPI unsigned int ecore_con_socks_version_get(Ecore_Con_Socks *ecs);
1039 1039
1040/** 1040/**
1041 * @brief Remove a SOCKS v4 proxy from the proxy list and delete it 1041 * @brief Removes a SOCKS v4 proxy from the proxy list and delete it.
1042 * 1042 *
1043 * Use this to remove a SOCKS proxy from the proxy list by directly deleting the object given. 1043 * Use this to remove a SOCKS proxy from the proxy list by directly deleting the object given.
1044 * @param ecs The proxy object to delete 1044 * @param ecs The proxy object to delete
@@ -1048,7 +1048,7 @@ EAPI unsigned int ecore_con_socks_version_get(Ecore_Con_Socks *ecs);
1048EAPI void ecore_con_socks_remote_del(Ecore_Con_Socks *ecs); 1048EAPI void ecore_con_socks_remote_del(Ecore_Con_Socks *ecs);
1049 1049
1050/** 1050/**
1051 * @brief Set a proxy object to be used with the next server created with ecore_con_server_connect() 1051 * @brief Sets a proxy object to be used with the next server created with ecore_con_server_connect().
1052 * 1052 *
1053 * This function sets a proxy for the next ecore_con connection. After the next server is created, 1053 * This function sets a proxy for the next ecore_con connection. After the next server is created,
1054 * the proxy will NEVER be applied again unless explicitly enabled. 1054 * the proxy will NEVER be applied again unless explicitly enabled.
@@ -1059,19 +1059,19 @@ EAPI void ecore_con_socks_remote_del(Ecore_Con_Socks *ecs);
1059EAPI void ecore_con_socks_apply_once(Ecore_Con_Socks *ecs); 1059EAPI void ecore_con_socks_apply_once(Ecore_Con_Socks *ecs);
1060 1060
1061/** 1061/**
1062 * @brief Set a proxy object to be used with all servers created with ecore_con_server_connect() 1062 * @brief Sets a proxy object to be used with all servers created with ecore_con_server_connect().
1063 * 1063 *
1064 * This function sets a proxy for all ecore_con connections. It will always be used. 1064 * This function sets a proxy for all ecore_con connections. It will always be used.
1065 * @param ecs The proxy object 1065 * @param ecs The proxy object.
1066 * @see ecore_con_socks_apply_once() 1066 * @see ecore_con_socks_apply_once().
1067 * @since 1.2 1067 * @since 1.2
1068 * @note ecore-con supports setting this through environment variables like so: 1068 * @note ecore-con supports setting this through environment variables like so:
1069 * ECORE_CON_SOCKS_V4=[user@]server-port:lookup 1069 * ECORE_CON_SOCKS_V4=[user@]server-port:lookup
1070 * ECORE_CON_SOCKS_V5=[user@]server-port:lookup 1070 * ECORE_CON_SOCKS_V5=[user@]server-port:lookup
1071 * user is the OPTIONAL string that would be passed to the proxy as the username 1071 * user is the OPTIONAL string that would be passed to the proxy as the username.
1072 * server is the IP_ADDRESS of the proxy server 1072 * server is the IP_ADDRESS of the proxy server.
1073 * port is the port to connect to on the proxy server 1073 * port is the port to connect to on the proxy server.
1074 * lookup is 1 if the proxy should perform all DNS lookups, otherwise 0 or omitted 1074 * lookup is 1 if the proxy should perform all DNS lookups, otherwise 0 or omitted.
1075 */ 1075 */
1076EAPI void ecore_con_socks_apply_always(Ecore_Con_Socks *ecs); 1076EAPI void ecore_con_socks_apply_always(Ecore_Con_Socks *ecs);
1077 1077
@@ -1149,7 +1149,7 @@ EAPI void ecore_con_socks_apply_always(Ecore_Con_Socks *ecs);
1149 */ 1149 */
1150 1150
1151/** 1151/**
1152 * @brief Create a local path to connect the socket. 1152 * @brief Creates a local path to connect the socket.
1153 * 1153 *
1154 * In the old API, ecore_con_server_add() and 1154 * In the old API, ecore_con_server_add() and
1155 * ecore_con_server_connect() calculated a local path for connections 1155 * ecore_con_server_connect() calculated a local path for connections
@@ -1185,15 +1185,15 @@ EAPI void ecore_con_socks_apply_always(Ecore_Con_Socks *ecs);
1185EAPI char *ecore_con_local_path_new(Eina_Bool is_system, const char *name, int port) EINA_WARN_UNUSED_RESULT EINA_MALLOC EINA_ARG_NONNULL(2); 1185EAPI char *ecore_con_local_path_new(Eina_Bool is_system, const char *name, int port) EINA_WARN_UNUSED_RESULT EINA_MALLOC EINA_ARG_NONNULL(2);
1186 1186
1187/** 1187/**
1188 * @brief Create a server to listen for connections. 1188 * @brief Creates a server to listen for connections.
1189 * 1189 *
1190 * @param type The connection type. 1190 * @param type The connection type.
1191 * @param name Name to associate with the socket. It is used when 1191 * @param name Name to associate with the socket. It is used when
1192 * generating the socket name of a Unix socket, or for 1192 * generating the socket name of a Unix socket, or for
1193 * determining what host to listen on for TCP sockets. 1193 * determining what host to listen on for TCP sockets.
1194 * @c NULL will not be accepted. 1194 * @c NULL will not be accepted.
1195 * @param port Number to identify socket. When a Unix socket is used, 1195 * @param port Number to identify socket. When a Unix socket is used,
1196 * it becomes part of the socket name. When a TCP socket 1196 * it becomes part of the socket name. When a TCP socket
1197 * is used, it is used as the TCP port. 1197 * is used, it is used as the TCP port.
1198 * @param data Data to associate with the created Ecore_Con_Server 1198 * @param data Data to associate with the created Ecore_Con_Server
1199 * object. 1199 * object.
@@ -1231,14 +1231,14 @@ EAPI Ecore_Con_Server *ecore_con_server_add(Ecore_Con_Type type,
1231 const void *data); 1231 const void *data);
1232 1232
1233/** 1233/**
1234 * @brief Create a connection to the specified server and return an associated object. 1234 * @brief Creates a connection to the specified server and return an associated object.
1235 * 1235 *
1236 * @param type The connection type. 1236 * @param type The connection type.
1237 * @param name Name used when determining what socket to connect to. 1237 * @param name Name used when determining what socket to connect to.
1238 * It is used to generate the socket name when the socket 1238 * It is used to generate the socket name when the socket
1239 * is a Unix socket. It is used as the hostname when 1239 * is a Unix socket. It is used as the hostname when
1240 * connecting with a TCP socket. 1240 * connecting with a TCP socket.
1241 * @param port Number to identify the socket to connect to. Used when 1241 * @param port Number to identify the socket to connect to. Used when
1242 * generating the socket name for a Unix socket, or as the 1242 * generating the socket name for a Unix socket, or as the
1243 * TCP port when connecting to a TCP socket. 1243 * TCP port when connecting to a TCP socket.
1244 * @param data Data to associate with the created Ecore_Con_Server 1244 * @param data Data to associate with the created Ecore_Con_Server
@@ -1251,9 +1251,9 @@ EAPI Ecore_Con_Server *ecore_con_server_add(Ecore_Con_Type type,
1251 * if that is not set, then from HOME, even if this is not set, then from 1251 * if that is not set, then from HOME, even if this is not set, then from
1252 * TMPDIR. If none is set, then path would be /tmp. From this path the 1252 * TMPDIR. If none is set, then path would be /tmp. From this path the
1253 * function would connect to socket at "[path]/.ecore/[name]/[port]". If 1253 * function would connect to socket at "[path]/.ecore/[name]/[port]". If
1254 * port is negetive, then to socket at "[path]/.ecore/[name]". 1254 * port is negative, then to socket at "[path]/.ecore/[name]".
1255 * @li If @a type is @c ECORE_CON_LOCAL_SYSTEM, the server will connect to 1255 * @li If @a type is @c ECORE_CON_LOCAL_SYSTEM, the server will connect to
1256 * Unix socket at "/tmp/.ecore_service|[name]|[port]". If port is negetive, 1256 * Unix socket at "/tmp/.ecore_service|[name]|[port]". If port is negative,
1257 * then to Unix socket at "/tmp/.ecore_service|[name]". 1257 * then to Unix socket at "/tmp/.ecore_service|[name]".
1258 * @li If @a type is @c ECORE_CON_LOCAL_ABSTRACT, then port number is not 1258 * @li If @a type is @c ECORE_CON_LOCAL_ABSTRACT, then port number is not
1259 * considered while connecting to socket. 1259 * considered while connecting to socket.
@@ -1286,7 +1286,7 @@ EAPI Ecore_Con_Server *ecore_con_server_connect(Ecore_Con_Type type,
1286 const char *name, int port, 1286 const char *name, int port,
1287 const void *data); 1287 const void *data);
1288/** 1288/**
1289 * @brief Close the connection and free the given server. 1289 * @brief Closes the connection and free the given server.
1290 * 1290 *
1291 * @param svr The given server. 1291 * @param svr The given server.
1292 * @return Data associated with the server when it was created. 1292 * @return Data associated with the server when it was created.
@@ -1310,7 +1310,7 @@ EAPI void * ecore_con_server_del(Ecore_Con_Server *svr);
1310EAPI const char *ecore_con_server_name_get(const Ecore_Con_Server *svr); 1310EAPI const char *ecore_con_server_name_get(const Ecore_Con_Server *svr);
1311 1311
1312/** 1312/**
1313 * @brief Retrieve the data associated with the given server. 1313 * @brief Retrieves the data associated with the given server.
1314 * 1314 *
1315 * @param svr The given server. 1315 * @param svr The given server.
1316 * @return The associated data. 1316 * @return The associated data.
@@ -1319,10 +1319,10 @@ EAPI const char *ecore_con_server_name_get(const Ecore_Con_Server *svr);
1319 */ 1319 */
1320EAPI void * ecore_con_server_data_get(Ecore_Con_Server *svr); 1320EAPI void * ecore_con_server_data_get(Ecore_Con_Server *svr);
1321/** 1321/**
1322 * @brief Set the data associated with the given server. 1322 * @brief Sets the data associated with the given server.
1323 * 1323 *
1324 * @param svr The given server. 1324 * @param svr The given server.
1325 * @param data The data to associate with @p svr 1325 * @param data The data to associate with @p svr.
1326 * @return The previously associated data, if any. 1326 * @return The previously associated data, if any.
1327 * 1327 *
1328 * @see ecore_con_server_data_get() 1328 * @see ecore_con_server_data_get()
@@ -1330,7 +1330,7 @@ EAPI void * ecore_con_server_data_get(Ecore_Con_Server *svr);
1330EAPI void * ecore_con_server_data_set(Ecore_Con_Server *svr, 1330EAPI void * ecore_con_server_data_set(Ecore_Con_Server *svr,
1331 void *data); 1331 void *data);
1332/** 1332/**
1333 * @brief Retrieve whether the given server is currently connected. 1333 * @brief Retrieves whether the given server is currently connected.
1334 * 1334 *
1335 * @param svr The given server. 1335 * @param svr The given server.
1336 * @return @c EINA_TRUE if the server is connected, @c EINA_FALSE otherwise. 1336 * @return @c EINA_TRUE if the server is connected, @c EINA_FALSE otherwise.
@@ -1338,7 +1338,7 @@ EAPI void * ecore_con_server_data_set(Ecore_Con_Server *svr,
1338EAPI Eina_Bool ecore_con_server_connected_get(const Ecore_Con_Server *svr); 1338EAPI Eina_Bool ecore_con_server_connected_get(const Ecore_Con_Server *svr);
1339 1339
1340/** 1340/**
1341 * @brief Retrieve the server port in use. 1341 * @brief Retrieves the server port in use.
1342 * 1342 *
1343 * @param svr The given server. 1343 * @param svr The given server.
1344 * @return The server port in use. 1344 * @return The server port in use.
@@ -1347,18 +1347,18 @@ EAPI Eina_Bool ecore_con_server_connected_get(const Ecore_Con_Server *sv
1347 */ 1347 */
1348EAPI int ecore_con_server_port_get(const Ecore_Con_Server *svr); 1348EAPI int ecore_con_server_port_get(const Ecore_Con_Server *svr);
1349/** 1349/**
1350 * @brief Check how long a server has been connected 1350 * @brief Checks how long a server has been connected.
1351 * 1351 *
1352 * @param svr The server to check 1352 * @param svr The server to check
1353 * @return The total time, in seconds, that the server has been 1353 * @return The total time, in seconds, that the server has been
1354 * connected/running 1354 * connected/running.
1355 * 1355 *
1356 * This function is used to find out the time that has been elapsed since 1356 * This function is used to find out the time that has been elapsed since
1357 * ecore_con_server_add() succeeded. 1357 * ecore_con_server_add() succeeded.
1358 */ 1358 */
1359EAPI double ecore_con_server_uptime_get(const Ecore_Con_Server *svr); 1359EAPI double ecore_con_server_uptime_get(const Ecore_Con_Server *svr);
1360/** 1360/**
1361 * @brief Send the given data to the given server. 1361 * @brief Sends the given data to the given server.
1362 * 1362 *
1363 * @param svr The given server. 1363 * @param svr The given server.
1364 * @param data The given data. 1364 * @param data The given data.
@@ -1378,7 +1378,7 @@ EAPI int ecore_con_server_send(Ecore_Con_Server *svr,
1378 const void *data, 1378 const void *data,
1379 int size); 1379 int size);
1380/** 1380/**
1381 * @brief Set a limit on the number of clients that can be handled concurrently 1381 * @brief Sets a limit on the number of clients that can be handled concurrently
1382 * by the given server, and a policy on what to do if excess clients try to 1382 * by the given server, and a policy on what to do if excess clients try to
1383 * connect. 1383 * connect.
1384 * 1384 *
@@ -1388,7 +1388,7 @@ EAPI int ecore_con_server_send(Ecore_Con_Server *svr,
1388 * effectively disables the server. 1388 * effectively disables the server.
1389 * @param reject_excess_clients Set to 1 to automatically disconnect 1389 * @param reject_excess_clients Set to 1 to automatically disconnect
1390 * excess clients as soon as they connect if you are 1390 * excess clients as soon as they connect if you are
1391 * already handling client_limit clients. Set to 0 1391 * already handling client_limit clients. Set to 0
1392 * (default) to just hold off on the "accept()" 1392 * (default) to just hold off on the "accept()"
1393 * system call until the number of active clients 1393 * system call until the number of active clients
1394 * drops. This causes the kernel to queue up to 4096 1394 * drops. This causes the kernel to queue up to 4096
@@ -1419,7 +1419,7 @@ EAPI void ecore_con_server_client_limit_set(Ecore_Con_Server *svr,
1419EAPI const Eina_List *ecore_con_server_clients_get(const Ecore_Con_Server *svr); 1419EAPI const Eina_List *ecore_con_server_clients_get(const Ecore_Con_Server *svr);
1420 1420
1421/** 1421/**
1422 * @brief Get the IP address of a server that has been connected to. 1422 * @brief Gets the IP address of a server that has been connected to.
1423 * 1423 *
1424 * @param svr The given server. 1424 * @param svr The given server.
1425 * @return A pointer to an internal string that contains the IP address of 1425 * @return A pointer to an internal string that contains the IP address of
@@ -1430,7 +1430,7 @@ EAPI const Eina_List *ecore_con_server_clients_get(const Ecore_Con_Server *svr);
1430 */ 1430 */
1431EAPI const char * ecore_con_server_ip_get(const Ecore_Con_Server *svr); 1431EAPI const char * ecore_con_server_ip_get(const Ecore_Con_Server *svr);
1432/** 1432/**
1433 * @brief Flush all pending data to the given server. 1433 * @brief Flushes all pending data to the given server.
1434 * 1434 *
1435 * @param svr The given server. 1435 * @param svr The given server.
1436 * 1436 *
@@ -1441,10 +1441,10 @@ EAPI const char * ecore_con_server_ip_get(const Ecore_Con_Server *svr);
1441 */ 1441 */
1442EAPI void ecore_con_server_flush(Ecore_Con_Server *svr); 1442EAPI void ecore_con_server_flush(Ecore_Con_Server *svr);
1443/** 1443/**
1444 * @brief Set the default time after which an inactive client will be disconnected 1444 * @brief Sets the default time after which an inactive client will be disconnected.
1445 * 1445 *
1446 * @param svr The server object 1446 * @param svr The server object.
1447 * @param timeout The timeout, in seconds, to disconnect after 1447 * @param timeout The timeout, in seconds, to disconnect after.
1448 * 1448 *
1449 * This function is used by the server to set the default idle timeout on 1449 * This function is used by the server to set the default idle timeout on
1450 * clients. If the any of the clients becomes idle for a time higher than this 1450 * clients. If the any of the clients becomes idle for a time higher than this
@@ -1460,10 +1460,10 @@ EAPI void ecore_con_server_flush(Ecore_Con_Server *svr);
1460 */ 1460 */
1461EAPI void ecore_con_server_timeout_set(Ecore_Con_Server *svr, double timeout); 1461EAPI void ecore_con_server_timeout_set(Ecore_Con_Server *svr, double timeout);
1462/** 1462/**
1463 * @brief Get the default time after which an inactive client will be disconnected 1463 * @brief Gets the default time after which an inactive client will be disconnected.
1464 * 1464 *
1465 * @param svr The server object 1465 * @param svr The server object.
1466 * @return The timeout, in seconds, to disconnect after 1466 * @return The timeout, in seconds, to disconnect after.
1467 * 1467 *
1468 * This function is used to get the idle timeout for clients. A value of < 1 1468 * This function is used to get the idle timeout for clients. A value of < 1
1469 * means the idle timeout is disabled. 1469 * means the idle timeout is disabled.
@@ -1474,24 +1474,24 @@ EAPI void ecore_con_server_timeout_set(Ecore_Con_Server *svr, doubl
1474EAPI double ecore_con_server_timeout_get(const Ecore_Con_Server *svr); 1474EAPI double ecore_con_server_timeout_get(const Ecore_Con_Server *svr);
1475 1475
1476/** 1476/**
1477 * @brief Get the fd that the server is connected to 1477 * @brief Gets the fd that the server is connected to.
1478 * 1478 *
1479 * @param svr The server object 1479 * @param svr The server object
1480 * @return The fd, or -1 on failure 1480 * @return The fd, or @c -1 on failure
1481 * 1481 *
1482 * This function returns the fd which is used by the underlying server connection. 1482 * This function returns the fd which is used by the underlying server connection.
1483 * It should not be tampered with unless you REALLY know what you are doing. 1483 * It should not be tampered with unless you REALLY know what you are doing.
1484 * @note This function is only valid for servers created with ecore_con_server_connect() 1484 * @note This function is only valid for servers created with ecore_con_server_connect().
1485 * @warning Seriously. Don't use this unless you know what you are doing. 1485 * @warning Seriously. Don't use this unless you know what you are doing.
1486 * @since 1.1 1486 * @since 1.1
1487 */ 1487 */
1488EAPI int ecore_con_server_fd_get(const Ecore_Con_Server *svr); 1488EAPI int ecore_con_server_fd_get(const Ecore_Con_Server *svr);
1489 1489
1490/** 1490/**
1491 * @brief Get the fd that the client is connected to 1491 * @brief Gets the fd that the client is connected to.
1492 * 1492 *
1493 * @param cl The client object 1493 * @param cl The client object
1494 * @return The fd, or -1 on failure 1494 * @return The fd, or @c -1 on failure
1495 * 1495 *
1496 * This function returns the fd which is used by the underlying client connection. 1496 * This function returns the fd which is used by the underlying client connection.
1497 * It should not be tampered with unless you REALLY know what you are doing. 1497 * It should not be tampered with unless you REALLY know what you are doing.
@@ -1523,7 +1523,7 @@ EAPI int ecore_con_client_fd_get(const Ecore_Con_Client *cl);
1523 */ 1523 */
1524 1524
1525/** 1525/**
1526 * @brief Send the given data to the given client. 1526 * @brief Sends the given data to the given client.
1527 * 1527 *
1528 * @param cl The given client. 1528 * @param cl The given client.
1529 * @param data The given data. 1529 * @param data The given data.
@@ -1543,14 +1543,14 @@ EAPI int ecore_con_client_send(Ecore_Con_Client *cl,
1543 const void *data, 1543 const void *data,
1544 int size); 1544 int size);
1545/** 1545/**
1546 * @brief Close the connection and free memory allocated to the given client. 1546 * @brief Closes the connection and free memory allocated to the given client.
1547 * 1547 *
1548 * @param cl The given client. 1548 * @param cl The given client.
1549 * @return Data associated with the client. 1549 * @return Data associated with the client.
1550 */ 1550 */
1551EAPI void * ecore_con_client_del(Ecore_Con_Client *cl); 1551EAPI void * ecore_con_client_del(Ecore_Con_Client *cl);
1552/** 1552/**
1553 * @brief Set the data associated with the given client to @p data. 1553 * @brief Sets the data associated with the given client to @p data.
1554 * 1554 *
1555 * @param cl The given client. 1555 * @param cl The given client.
1556 * @param data What to set the data to. 1556 * @param data What to set the data to.
@@ -1558,7 +1558,7 @@ EAPI void * ecore_con_client_del(Ecore_Con_Client *cl);
1558EAPI void ecore_con_client_data_set(Ecore_Con_Client *cl, 1558EAPI void ecore_con_client_data_set(Ecore_Con_Client *cl,
1559 const void *data); 1559 const void *data);
1560/** 1560/**
1561 * @brief Retrieve the data associated with the given client. 1561 * @brief Retrieves the data associated with the given client.
1562 * 1562 *
1563 * @param cl The given client. 1563 * @param cl The given client.
1564 * @return The data associated with @p cl. 1564 * @return The data associated with @p cl.
@@ -1566,7 +1566,7 @@ EAPI void ecore_con_client_data_set(Ecore_Con_Client *cl,
1566EAPI void * ecore_con_client_data_get(Ecore_Con_Client *cl); 1566EAPI void * ecore_con_client_data_get(Ecore_Con_Client *cl);
1567 1567
1568/** 1568/**
1569 * @brief Get the IP address of a client that has connected. 1569 * @brief Gets the IP address of a client that has connected.
1570 * 1570 *
1571 * @param cl The given client. 1571 * @param cl The given client.
1572 * @return A pointer to an internal string that contains the IP address of 1572 * @return A pointer to an internal string that contains the IP address of
@@ -1577,7 +1577,7 @@ EAPI void * ecore_con_client_data_get(Ecore_Con_Client *cl);
1577 */ 1577 */
1578EAPI const char * ecore_con_client_ip_get(const Ecore_Con_Client *cl); 1578EAPI const char * ecore_con_client_ip_get(const Ecore_Con_Client *cl);
1579/** 1579/**
1580 * @brief Flush all pending data to the given client. 1580 * @brief Flushes all pending data to the given client.
1581 * 1581 *
1582 * @param cl The given client. 1582 * @param cl The given client.
1583 * 1583 *
@@ -1588,7 +1588,7 @@ EAPI const char * ecore_con_client_ip_get(const Ecore_Con_Client *cl);
1588 */ 1588 */
1589EAPI void ecore_con_client_flush(Ecore_Con_Client *cl); 1589EAPI void ecore_con_client_flush(Ecore_Con_Client *cl);
1590/** 1590/**
1591 * @brief Check how long a client has been connected 1591 * @brief Checks how long a client has been connected.
1592 * 1592 *
1593 * @param cl The client to check 1593 * @param cl The client to check
1594 * @return The total time, in seconds, that the client has been connected to 1594 * @return The total time, in seconds, that the client has been connected to
@@ -1598,11 +1598,11 @@ EAPI void ecore_con_client_flush(Ecore_Con_Client *cl);
1598 */ 1598 */
1599EAPI double ecore_con_client_uptime_get(const Ecore_Con_Client *cl); 1599EAPI double ecore_con_client_uptime_get(const Ecore_Con_Client *cl);
1600/** 1600/**
1601 * @brief Get the default time after which the client will be disconnected when 1601 * @brief Gets the default time after which the client will be disconnected when
1602 * inactive 1602 * inactive.
1603 * 1603 *
1604 * @param cl The client object 1604 * @param cl The client object.
1605 * @return The timeout, in seconds, to disconnect after 1605 * @return The timeout, in seconds, to disconnect after.
1606 * 1606 *
1607 * This function is used to get the idle timeout for a client. A value of < 1 1607 * This function is used to get the idle timeout for a client. A value of < 1
1608 * means the idle timeout is disabled. 1608 * means the idle timeout is disabled.
@@ -1611,7 +1611,7 @@ EAPI double ecore_con_client_uptime_get(const Ecore_Con_Client *cl);
1611 */ 1611 */
1612EAPI double ecore_con_client_timeout_get(const Ecore_Con_Client *cl); 1612EAPI double ecore_con_client_timeout_get(const Ecore_Con_Client *cl);
1613/** 1613/**
1614 * @brief Set the time after which the client will be disconnected when inactive 1614 * @brief Sets the time after which the client will be disconnected when inactive.
1615 * 1615 *
1616 * @param cl The client object 1616 * @param cl The client object
1617 * @param timeout The timeout, in seconds, to disconnect after 1617 * @param timeout The timeout, in seconds, to disconnect after
@@ -1631,17 +1631,17 @@ EAPI double ecore_con_client_timeout_get(const Ecore_Con_Client *cl);
1631 */ 1631 */
1632EAPI void ecore_con_client_timeout_set(Ecore_Con_Client *cl, double timeout); 1632EAPI void ecore_con_client_timeout_set(Ecore_Con_Client *cl, double timeout);
1633/** 1633/**
1634 * @brief Return whether the client is still connected 1634 * @brief Returns whether the client is still connected.
1635 * 1635 *
1636 * @param cl The given client. 1636 * @param cl The given client.
1637 * @return @c EINA_TRUE if connected, @c EINA_FALSE otherwise. 1637 * @return @c EINA_TRUE if connected, @c EINA_FALSE otherwise.
1638 */ 1638 */
1639EAPI Eina_Bool ecore_con_client_connected_get(const Ecore_Con_Client *cl); 1639EAPI Eina_Bool ecore_con_client_connected_get(const Ecore_Con_Client *cl);
1640/** 1640/**
1641 * @brief Return the port that the client has connected to 1641 * @brief Returns the port that the client has connected to.
1642 * 1642 *
1643 * @param cl The client 1643 * @param cl The client
1644 * @return The port that @p cl has connected to, or -1 on error 1644 * @return The port that @p cl has connected to, or @c -1 on error
1645 * Use this function to return the port on which a given client has connected. 1645 * Use this function to return the port on which a given client has connected.
1646 */ 1646 */
1647EAPI int ecore_con_client_port_get(const Ecore_Con_Client *cl); 1647EAPI int ecore_con_client_port_get(const Ecore_Con_Client *cl);
@@ -1770,9 +1770,9 @@ typedef enum _Ecore_Con_Url_Http_Version
1770} Ecore_Con_Url_Http_Version; 1770} Ecore_Con_Url_Http_Version;
1771 1771
1772/** 1772/**
1773 * @brief Change the HTTP version used for the request 1773 * @brief Changes the HTTP version used for the request.
1774 * @param url_con Connection object through which the request will be sent. 1774 * @param url_con Connection object through which the request will be sent.
1775 * @param version The version to be used 1775 * @param version The version to be used.
1776 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure to change version. 1776 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure to change version.
1777 * @since 1.2 1777 * @since 1.2
1778 * @see ecore_con_url_pipeline_get() 1778 * @see ecore_con_url_pipeline_get()
@@ -1780,7 +1780,7 @@ typedef enum _Ecore_Con_Url_Http_Version
1780EAPI Eina_Bool ecore_con_url_http_version_set(Ecore_Con_Url *url_con, Ecore_Con_Url_Http_Version version); 1780EAPI Eina_Bool ecore_con_url_http_version_set(Ecore_Con_Url *url_con, Ecore_Con_Url_Http_Version version);
1781 1781
1782/** 1782/**
1783 * @brief Initialise the Ecore_Con_Url library. 1783 * @brief Initializes the Ecore_Con_Url library.
1784 * @return Number of times the library has been initialised without being 1784 * @return Number of times the library has been initialised without being
1785 * shut down. 1785 * shut down.
1786 * 1786 *
@@ -1790,7 +1790,7 @@ EAPI Eina_Bool ecore_con_url_http_version_set(Ecore_Con_Url *url_con, Ec
1790EAPI int ecore_con_url_init(void); 1790EAPI int ecore_con_url_init(void);
1791 1791
1792/** 1792/**
1793 * @brief Shut down the Ecore_Con_Url library. 1793 * @brief Shuts down the Ecore_Con_Url library.
1794 * @return Number of calls that still uses Ecore_Con_Url 1794 * @return Number of calls that still uses Ecore_Con_Url
1795 * 1795 *
1796 * @note This function doesn't call ecore_con_shutdown(). You still need to call 1796 * @note This function doesn't call ecore_con_shutdown(). You still need to call
@@ -1799,7 +1799,7 @@ EAPI int ecore_con_url_init(void);
1799EAPI int ecore_con_url_shutdown(void); 1799EAPI int ecore_con_url_shutdown(void);
1800 1800
1801/** 1801/**
1802 * @brief Enable or disable HTTP 1.1 pipelining. 1802 * @brief Enables or disable HTTP 1.1 pipelining.
1803 * @param enable @c EINA_TRUE will turn it on, @c EINA_FALSE will disable it. 1803 * @param enable @c EINA_TRUE will turn it on, @c EINA_FALSE will disable it.
1804 * 1804 *
1805 * Pipelining allows to send one request after another one, without having to 1805 * Pipelining allows to send one request after another one, without having to
@@ -1823,7 +1823,7 @@ EAPI void ecore_con_url_pipeline_set(Eina_Bool enable);
1823EAPI Eina_Bool ecore_con_url_pipeline_get(void); 1823EAPI Eina_Bool ecore_con_url_pipeline_get(void);
1824 1824
1825/** 1825/**
1826 * @brief Create and initialize a new Ecore_Con_Url connection object. 1826 * @brief Creates and initializes a new Ecore_Con_Url connection object.
1827 * 1827 *
1828 * @param url URL that will receive requests. Can be changed using 1828 * @param url URL that will receive requests. Can be changed using
1829 * ecore_con_url_url_set. 1829 * ecore_con_url_url_set.
@@ -1858,7 +1858,7 @@ EAPI Eina_Bool ecore_con_url_url_set(Ecore_Con_Url *url_con,
1858EAPI const char *ecore_con_url_url_get(Ecore_Con_Url *url_con); 1858EAPI const char *ecore_con_url_url_get(Ecore_Con_Url *url_con);
1859 1859
1860/** 1860/**
1861 * @brief Create a custom connection object. 1861 * @brief Creates a custom connection object.
1862 * 1862 *
1863 * @param url URL that will receive requests 1863 * @param url URL that will receive requests
1864 * @param custom_request Custom request (e.g. GET, POST, HEAD, PUT, etc) 1864 * @param custom_request Custom request (e.g. GET, POST, HEAD, PUT, etc)
@@ -1875,7 +1875,7 @@ EAPI const char *ecore_con_url_url_get(Ecore_Con_Url *url_con);
1875EAPI Ecore_Con_Url * ecore_con_url_custom_new(const char *url, 1875EAPI Ecore_Con_Url * ecore_con_url_custom_new(const char *url,
1876 const char *custom_request); 1876 const char *custom_request);
1877/** 1877/**
1878 * @brief Destroy a Ecore_Con_Url connection object. 1878 * @brief Destroys an Ecore_Con_Url connection object.
1879 * 1879 *
1880 * @param url_con Connection object to free. 1880 * @param url_con Connection object to free.
1881 * 1881 *
@@ -1884,7 +1884,7 @@ EAPI Ecore_Con_Url * ecore_con_url_custom_new(const char *url,
1884EAPI void ecore_con_url_free(Ecore_Con_Url *url_con); 1884EAPI void ecore_con_url_free(Ecore_Con_Url *url_con);
1885 1885
1886/** 1886/**
1887 * @brief Associate data with a connection object. 1887 * @brief Associates data with a connection object.
1888 * 1888 *
1889 * @param url_con Connection object to associate data. 1889 * @param url_con Connection object to associate data.
1890 * @param data Data to be set. 1890 * @param data Data to be set.
@@ -1897,7 +1897,7 @@ EAPI void ecore_con_url_free(Ecore_Con_Url *url_con);
1897EAPI void ecore_con_url_data_set(Ecore_Con_Url *url_con, 1897EAPI void ecore_con_url_data_set(Ecore_Con_Url *url_con,
1898 void *data); 1898 void *data);
1899/** 1899/**
1900 * @brief Retrieve data associated with a Ecore_Con_Url connection object. 1900 * @brief Retrieves data associated with a Ecore_Con_Url connection object.
1901 * 1901 *
1902 * @param url_con Connection object to retrieve data from. 1902 * @param url_con Connection object to retrieve data from.
1903 * 1903 *
@@ -1910,7 +1910,7 @@ EAPI void ecore_con_url_data_set(Ecore_Con_Url *url_con,
1910 */ 1910 */
1911EAPI void * ecore_con_url_data_get(Ecore_Con_Url *url_con); 1911EAPI void * ecore_con_url_data_get(Ecore_Con_Url *url_con);
1912/** 1912/**
1913 * @brief Add an additional header to the request connection object. 1913 * @brief Adds an additional header to the request connection object.
1914 * 1914 *
1915 * @param url_con Connection object 1915 * @param url_con Connection object
1916 * @param key Header key 1916 * @param key Header key
@@ -1930,7 +1930,7 @@ EAPI void ecore_con_url_additional_header_add(Ecore_Con_Url *url_co
1930 const char *key, 1930 const char *key,
1931 const char *value); 1931 const char *value);
1932/** 1932/**
1933 * @brief Clean additional headers. 1933 * @brief Cleans additional headers.
1934 * 1934 *
1935 * @param url_con Connection object to clean additional headers. 1935 * @param url_con Connection object to clean additional headers.
1936 * 1936 *
@@ -1943,7 +1943,7 @@ EAPI void ecore_con_url_additional_header_add(Ecore_Con_Url *url_co
1943 */ 1943 */
1944EAPI void ecore_con_url_additional_headers_clear(Ecore_Con_Url *url_con); 1944EAPI void ecore_con_url_additional_headers_clear(Ecore_Con_Url *url_con);
1945/** 1945/**
1946 * @brief Retrieve headers from last request sent. 1946 * @brief Retrieves headers from last request sent.
1947 * 1947 *
1948 * @param url_con Connection object to retrieve response headers from. 1948 * @param url_con Connection object to retrieve response headers from.
1949 * 1949 *
@@ -1955,7 +1955,7 @@ EAPI void ecore_con_url_additional_headers_clear(Ecore_Con_Url *url
1955 */ 1955 */
1956EAPI const Eina_List * ecore_con_url_response_headers_get(Ecore_Con_Url *url_con); 1956EAPI const Eina_List * ecore_con_url_response_headers_get(Ecore_Con_Url *url_con);
1957/** 1957/**
1958 * @brief Set up a file for receiving response data. 1958 * @brief Sets up a file for receiving response data.
1959 * 1959 *
1960 * @param url_con Connection object to set file 1960 * @param url_con Connection object to set file
1961 * @param fd File descriptor associated with the file. A negative value will 1961 * @param fd File descriptor associated with the file. A negative value will
@@ -1970,7 +1970,7 @@ EAPI const Eina_List * ecore_con_url_response_headers_get(Ecore_Con_Url *url_con
1970 */ 1970 */
1971EAPI void ecore_con_url_fd_set(Ecore_Con_Url *url_con, int fd); 1971EAPI void ecore_con_url_fd_set(Ecore_Con_Url *url_con, int fd);
1972/** 1972/**
1973 * @brief Retrieve the number of bytes received. 1973 * @brief Retrieves the number of bytes received.
1974 * 1974 *
1975 * Retrieve the number of bytes received on the last request of the given 1975 * Retrieve the number of bytes received on the last request of the given
1976 * connection object. 1976 * connection object.
@@ -1984,7 +1984,7 @@ EAPI void ecore_con_url_fd_set(Ecore_Con_Url *url_con, int fd);
1984 */ 1984 */
1985EAPI int ecore_con_url_received_bytes_get(Ecore_Con_Url *url_con); 1985EAPI int ecore_con_url_received_bytes_get(Ecore_Con_Url *url_con);
1986/** 1986/**
1987 * @brief Set url_con to use http auth, with given username and password, "safely" or not. 1987 * @brief Sets url_con to use http auth, with given username and password, "safely" or not.
1988 * 1988 *
1989 * @param url_con Connection object to perform a request on, previously created 1989 * @param url_con Connection object to perform a request on, previously created
1990 * with ecore_con_url_new() or ecore_con_url_custom_new(). 1990 * with ecore_con_url_new() or ecore_con_url_custom_new().
@@ -2002,7 +2002,7 @@ EAPI Eina_Bool ecore_con_url_httpauth_set(Ecore_Con_Url *url_con,
2002 const char *password, 2002 const char *password,
2003 Eina_Bool safe); 2003 Eina_Bool safe);
2004/** 2004/**
2005 * @brief Send a get request. 2005 * @brief Sends a get request.
2006 * 2006 *
2007 * @param url_con Connection object to perform a request on, previously created 2007 * @param url_con Connection object to perform a request on, previously created
2008 * 2008 *
@@ -2023,7 +2023,7 @@ EAPI Eina_Bool ecore_con_url_httpauth_set(Ecore_Con_Url *url_con,
2023 */ 2023 */
2024EAPI Eina_Bool ecore_con_url_get(Ecore_Con_Url *url_con); 2024EAPI Eina_Bool ecore_con_url_get(Ecore_Con_Url *url_con);
2025/** 2025/**
2026 * @brief Send a HEAD request. 2026 * @brief Sends a HEAD request.
2027 * 2027 *
2028 * @param url_con Connection object to perform a request on, previously created 2028 * @param url_con Connection object to perform a request on, previously created
2029 * 2029 *
@@ -2043,7 +2043,7 @@ EAPI Eina_Bool ecore_con_url_get(Ecore_Con_Url *url_con);
2043 */ 2043 */
2044EAPI Eina_Bool ecore_con_url_head(Ecore_Con_Url *url_con); 2044EAPI Eina_Bool ecore_con_url_head(Ecore_Con_Url *url_con);
2045/** 2045/**
2046 * @brief Send a post request. 2046 * @brief Sends a post request.
2047 * 2047 *
2048 * @param url_con Connection object to perform a request on, previously created 2048 * @param url_con Connection object to perform a request on, previously created
2049 * with ecore_con_url_new() or ecore_con_url_custom_new(). 2049 * with ecore_con_url_new() or ecore_con_url_custom_new().
@@ -2074,7 +2074,7 @@ EAPI Eina_Bool ecore_con_url_post(Ecore_Con_Url *url_con,
2074 const void *data, long length, 2074 const void *data, long length,
2075 const char *content_type); 2075 const char *content_type);
2076/** 2076/**
2077 * @brief Set whether HTTP requests should be conditional, dependent on 2077 * @brief Sets whether HTTP requests should be conditional, dependent on
2078 * modification time. 2078 * modification time.
2079 * 2079 *
2080 * @param url_con Ecore_Con_Url to act upon. 2080 * @param url_con Ecore_Con_Url to act upon.
@@ -2093,7 +2093,7 @@ EAPI void ecore_con_url_time(Ecore_Con_Url *url_con,
2093 double timestamp); 2093 double timestamp);
2094 2094
2095/** 2095/**
2096 * @brief Upload a file to an ftp site. 2096 * @brief Uploads a file to an ftp site.
2097 * 2097 *
2098 * @param url_con The Ecore_Con_Url object to send with 2098 * @param url_con The Ecore_Con_Url object to send with
2099 * @param filename The path to the file to send 2099 * @param filename The path to the file to send
@@ -2111,7 +2111,7 @@ EAPI Eina_Bool ecore_con_url_ftp_upload(Ecore_Con_Url *url_con,
2111 const char *pass, 2111 const char *pass,
2112 const char *upload_dir); 2112 const char *upload_dir);
2113/** 2113/**
2114 * @brief Toggle libcurl's verbose output. 2114 * @brief Toggles libcurl's verbose output.
2115 * 2115 *
2116 * @param url_con Ecore_Con_Url instance which will be acted upon. 2116 * @param url_con Ecore_Con_Url instance which will be acted upon.
2117 * @param verbose Whether or not to enable libcurl's verbose output. 2117 * @param verbose Whether or not to enable libcurl's verbose output.
@@ -2123,7 +2123,7 @@ EAPI Eina_Bool ecore_con_url_ftp_upload(Ecore_Con_Url *url_con,
2123EAPI void ecore_con_url_verbose_set(Ecore_Con_Url *url_con, 2123EAPI void ecore_con_url_verbose_set(Ecore_Con_Url *url_con,
2124 Eina_Bool verbose); 2124 Eina_Bool verbose);
2125/** 2125/**
2126 * @brief Enable or disable EPSV extension 2126 * @brief Enables or disables EPSV extension.
2127 * @param url_con The Ecore_Con_Url instance which will be acted upon. 2127 * @param url_con The Ecore_Con_Url instance which will be acted upon.
2128 * @param use_epsv Boolean to enable/disable the EPSV extension. 2128 * @param use_epsv Boolean to enable/disable the EPSV extension.
2129 */ 2129 */
@@ -2131,7 +2131,7 @@ EAPI void ecore_con_url_ftp_use_epsv_set(Ecore_Con_Url *url_con,
2131 Eina_Bool use_epsv); 2131 Eina_Bool use_epsv);
2132 2132
2133/** 2133/**
2134 * @brief Enable the cookie engine for subsequent HTTP requests. 2134 * @brief Enables the cookie engine for subsequent HTTP requests.
2135 * 2135 *
2136 * @param url_con Ecore_Con_Url instance which will be acted upon. 2136 * @param url_con Ecore_Con_Url instance which will be acted upon.
2137 * 2137 *
@@ -2144,7 +2144,7 @@ EAPI void ecore_con_url_ftp_use_epsv_set(Ecore_Con_Url *url_con,
2144 */ 2144 */
2145EAPI void ecore_con_url_cookies_init(Ecore_Con_Url *url_con); 2145EAPI void ecore_con_url_cookies_init(Ecore_Con_Url *url_con);
2146/** 2146/**
2147 * @brief Control whether session cookies from previous sessions shall be loaded. 2147 * @brief Controls whether session cookies from previous sessions shall be loaded.
2148 * 2148 *
2149 * @param url_con Ecore_Con_Url instance which will be acted upon. 2149 * @param url_con Ecore_Con_Url instance which will be acted upon.
2150 * @param ignore If @c EINA_TRUE, ignore session cookies when loading cookies 2150 * @param ignore If @c EINA_TRUE, ignore session cookies when loading cookies
@@ -2166,7 +2166,7 @@ EAPI void ecore_con_url_cookies_init(Ecore_Con_Url *url_con);
2166EAPI void ecore_con_url_cookies_ignore_old_session_set(Ecore_Con_Url *url_con, 2166EAPI void ecore_con_url_cookies_ignore_old_session_set(Ecore_Con_Url *url_con,
2167 Eina_Bool ignore); 2167 Eina_Bool ignore);
2168/** 2168/**
2169 * @brief Clear currently loaded cookies. 2169 * @brief Clears currently loaded cookies.
2170 * @param url_con Ecore_Con_Url instance which will be acted upon. 2170 * @param url_con Ecore_Con_Url instance which will be acted upon.
2171 * 2171 *
2172 * The cleared cookies are removed and will not be sent in subsequent HTTP 2172 * The cleared cookies are removed and will not be sent in subsequent HTTP
@@ -2189,7 +2189,7 @@ EAPI void ecore_con_url_cookies_ignore_old_session_set(Ecore_Con_Ur
2189 */ 2189 */
2190EAPI void ecore_con_url_cookies_clear(Ecore_Con_Url *url_con); 2190EAPI void ecore_con_url_cookies_clear(Ecore_Con_Url *url_con);
2191/** 2191/**
2192 * @brief Clear currently loaded session cookies. 2192 * @brief Clears currently loaded session cookies.
2193 * 2193 *
2194 * @param url_con Ecore_Con_Url instance which will be acted upon. 2194 * @param url_con Ecore_Con_Url instance which will be acted upon.
2195 * 2195 *
@@ -2218,7 +2218,7 @@ EAPI void ecore_con_url_cookies_clear(Ecore_Con_Url *url_con);
2218 */ 2218 */
2219EAPI void ecore_con_url_cookies_session_clear(Ecore_Con_Url *url_con); 2219EAPI void ecore_con_url_cookies_session_clear(Ecore_Con_Url *url_con);
2220/** 2220/**
2221 * @brief Add a file to the list of files from which to load cookies. 2221 * @brief Adds a file to the list of files from which to load cookies.
2222 * 2222 *
2223 * @param url_con Ecore_Con_Url instance which will be acted upon. 2223 * @param url_con Ecore_Con_Url instance which will be acted upon.
2224 * @param file_name Name of the file that will be added to the list. 2224 * @param file_name Name of the file that will be added to the list.
@@ -2246,7 +2246,7 @@ EAPI void ecore_con_url_cookies_session_clear(Ecore_Con_Url *url_co
2246EAPI void ecore_con_url_cookies_file_add(Ecore_Con_Url *url_con, 2246EAPI void ecore_con_url_cookies_file_add(Ecore_Con_Url *url_con,
2247 const char * const file_name); 2247 const char * const file_name);
2248/** 2248/**
2249 * @brief Set the name of the file to which all current cookies will be written when 2249 * @brief Sets the name of the file to which all current cookies will be written when
2250 * either cookies are flushed or Ecore_Con is shut down. 2250 * either cookies are flushed or Ecore_Con is shut down.
2251 * 2251 *
2252 * @param url_con Ecore_Con_Url instance which will be acted upon. 2252 * @param url_con Ecore_Con_Url instance which will be acted upon.
@@ -2269,7 +2269,7 @@ EAPI void ecore_con_url_cookies_file_add(Ecore_Con_Url *url_con,
2269EAPI Eina_Bool ecore_con_url_cookies_jar_file_set(Ecore_Con_Url *url_con, 2269EAPI Eina_Bool ecore_con_url_cookies_jar_file_set(Ecore_Con_Url *url_con,
2270 const char * const cookiejar_file); 2270 const char * const cookiejar_file);
2271/** 2271/**
2272 * @brief Write all current cookies to the cookie jar immediately. 2272 * @brief Writes all current cookies to the cookie jar immediately.
2273 * 2273 *
2274 * @param url_con Ecore_Con_Url instance which will be acted upon. 2274 * @param url_con Ecore_Con_Url instance which will be acted upon.
2275 * 2275 *
@@ -2289,7 +2289,7 @@ EAPI int ecore_con_url_ssl_ca_set(Ecore_Con_Url *url_con,
2289 const char *ca_path); 2289 const char *ca_path);
2290 2290
2291/** 2291/**
2292 * @brief Set HTTP proxy to use. 2292 * @brief Sets HTTP proxy to use.
2293 * 2293 *
2294 * The parameter should be a char * to a zero terminated string holding 2294 * The parameter should be a char * to a zero terminated string holding
2295 * the host name or dotted IP address. To specify port number in this string, 2295 * the host name or dotted IP address. To specify port number in this string,
@@ -2308,7 +2308,7 @@ EAPI int ecore_con_url_ssl_ca_set(Ecore_Con_Url *url_con,
2308EAPI Eina_Bool ecore_con_url_proxy_set(Ecore_Con_Url *url_con, const char *proxy); 2308EAPI Eina_Bool ecore_con_url_proxy_set(Ecore_Con_Url *url_con, const char *proxy);
2309 2309
2310/** 2310/**
2311 * @brief Set zero terminated username to use for proxy. 2311 * @brief Sets zero terminated username to use for proxy.
2312 * 2312 *
2313 * If socks protocol is used for proxy, protocol should be socks5 and above. 2313 * If socks protocol is used for proxy, protocol should be socks5 and above.
2314 * 2314 *
@@ -2324,7 +2324,7 @@ EAPI Eina_Bool ecore_con_url_proxy_set(Ecore_Con_Url *url_con, const char *proxy
2324EAPI Eina_Bool ecore_con_url_proxy_username_set(Ecore_Con_Url *url_con, const char *username); 2324EAPI Eina_Bool ecore_con_url_proxy_username_set(Ecore_Con_Url *url_con, const char *username);
2325 2325
2326/** 2326/**
2327 * @brief Set zero terminated password to use for proxy. 2327 * @brief Sets zero terminated password to use for proxy.
2328 * 2328 *
2329 * If socks protocol is used for proxy, protocol should be socks5 and above. 2329 * If socks protocol is used for proxy, protocol should be socks5 and above.
2330 * 2330 *
@@ -2340,7 +2340,7 @@ EAPI Eina_Bool ecore_con_url_proxy_username_set(Ecore_Con_Url *url_con, const ch
2340EAPI Eina_Bool ecore_con_url_proxy_password_set(Ecore_Con_Url *url_con, const char *password); 2340EAPI Eina_Bool ecore_con_url_proxy_password_set(Ecore_Con_Url *url_con, const char *password);
2341 2341
2342/** 2342/**
2343 * @brief Set timeout in seconds. 2343 * @brief Sets timeout in seconds.
2344 * 2344 *
2345 * The maximum time in seconds that you allow the ecore con url transfer 2345 * The maximum time in seconds that you allow the ecore con url transfer
2346 * operation to take. Normally, name lookups can take a considerable time 2346 * operation to take. Normally, name lookups can take a considerable time
@@ -2357,7 +2357,7 @@ EAPI Eina_Bool ecore_con_url_proxy_password_set(Ecore_Con_Url *url_con, const ch
2357EAPI void ecore_con_url_timeout_set(Ecore_Con_Url *url_con, double timeout); 2357EAPI void ecore_con_url_timeout_set(Ecore_Con_Url *url_con, double timeout);
2358 2358
2359/** 2359/**
2360 * @brief Get the returned HTTP STATUS code 2360 * @brief Gets the returned HTTP STATUS code.
2361 * 2361 *
2362 * This is used to, at any time, try to return the status code for a transmission. 2362 * This is used to, at any time, try to return the status code for a transmission.
2363 * @param url_con Connection object 2363 * @param url_con Connection object
diff --git a/src/lib/ecore_con/Ecore_Con_Eet.h b/src/lib/ecore_con/Ecore_Con_Eet.h
index d1bc80a583..abbdb10906 100644
--- a/src/lib/ecore_con/Ecore_Con_Eet.h
+++ b/src/lib/ecore_con/Ecore_Con_Eet.h
@@ -35,7 +35,7 @@
35 * @defgroup Ecore_Con_Eet_Group Eet connection functions 35 * @defgroup Ecore_Con_Eet_Group Eet connection functions
36 * @ingroup Ecore_Con_Group 36 * @ingroup Ecore_Con_Group
37 * 37 *
38 * The Ecore Connection Eet library ( @c Ecore_Con_Eet) adds @c Eet data 38 * The Ecore Connection Eet library (@c Ecore_Con_Eet) adds @c Eet data
39 * serialization features to Ecore Connection objects. Its main aim is to 39 * serialization features to Ecore Connection objects. Its main aim is to
40 * provide a way to send @c Eet data streams to another program through sockets 40 * provide a way to send @c Eet data streams to another program through sockets
41 * using @c Ecore_Con objects. 41 * using @c Ecore_Con objects.
@@ -89,7 +89,7 @@ typedef Eina_Bool (*Ecore_Con_Eet_Server_Cb)(void *data, Ecore_Con_Reply *reply,
89#endif 89#endif
90 90
91/** 91/**
92 * Create a Ecore_Con_Eet server. 92 * @brief Creates an Ecore_Con_Eet server.
93 * 93 *
94 * @param server An existing Ecore_Con_Server that have been previously 94 * @param server An existing Ecore_Con_Server that have been previously
95 * created by the server program with @ref 95 * created by the server program with @ref
@@ -103,7 +103,7 @@ typedef Eina_Bool (*Ecore_Con_Eet_Server_Cb)(void *data, Ecore_Con_Reply *reply,
103EAPI Ecore_Con_Eet *ecore_con_eet_server_new(Ecore_Con_Server *server); 103EAPI Ecore_Con_Eet *ecore_con_eet_server_new(Ecore_Con_Server *server);
104 104
105/** 105/**
106 * Create a Ecore_Con_Eet client. 106 * @brief Creates an Ecore_Con_Eet client.
107 * 107 *
108 * @param server An existing Ecore_Con_Server that have been previously 108 * @param server An existing Ecore_Con_Server that have been previously
109 * returned by a call to @ref ecore_con_server_connect in the 109 * returned by a call to @ref ecore_con_server_connect in the
@@ -117,7 +117,7 @@ EAPI Ecore_Con_Eet *ecore_con_eet_server_new(Ecore_Con_Server *server);
117EAPI Ecore_Con_Eet *ecore_con_eet_client_new(Ecore_Con_Server *server); 117EAPI Ecore_Con_Eet *ecore_con_eet_client_new(Ecore_Con_Server *server);
118 118
119/** 119/**
120 * Free an existing Ecore_Con_Eet object. 120 * @brief Frees an existing Ecore_Con_Eet object.
121 * 121 *
122 * @param server An existing Ecore_Con_Eet object that have been previously 122 * @param server An existing Ecore_Con_Eet object that have been previously
123 * allocated by a @ref ecore_con_eet_server_new or @ref 123 * allocated by a @ref ecore_con_eet_server_new or @ref
@@ -127,7 +127,7 @@ EAPI Ecore_Con_Eet *ecore_con_eet_client_new(Ecore_Con_Server *server);
127EAPI void ecore_con_eet_server_free(Ecore_Con_Eet *ece); 127EAPI void ecore_con_eet_server_free(Ecore_Con_Eet *ece);
128 128
129/** 129/**
130 * Register an @c Eet data descriptor on a Ecore_Con_Eet object. 130 * @brief Registers an @c Eet data descriptor on a Ecore_Con_Eet object.
131 * 131 *
132 * @param ece An Ecore_Con_Eet object. 132 * @param ece An Ecore_Con_Eet object.
133 * @param name The name of the Eet stream to connect. 133 * @param name The name of the Eet stream to connect.
@@ -138,7 +138,7 @@ EAPI void ecore_con_eet_server_free(Ecore_Con_Eet *ece);
138EAPI void ecore_con_eet_register(Ecore_Con_Eet *ece, const char *name, Eet_Data_Descriptor *edd); 138EAPI void ecore_con_eet_register(Ecore_Con_Eet *ece, const char *name, Eet_Data_Descriptor *edd);
139 139
140/** 140/**
141 * Register a data callback on a Ecore_Con_Eet object. 141 * @brief Registers a data callback on a Ecore_Con_Eet object.
142 * When the Ecore_Con_Eet object is deleted, this automatically gets removed. 142 * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
143 * 143 *
144 * @param ece An Ecore_Con_Eet object. 144 * @param ece An Ecore_Con_Eet object.
@@ -150,7 +150,7 @@ EAPI void ecore_con_eet_register(Ecore_Con_Eet *ece, const char *name, Eet_Data_
150EAPI void ecore_con_eet_data_callback_add(Ecore_Con_Eet *ece, const char *name, Ecore_Con_Eet_Data_Cb func, const void *data); 150EAPI void ecore_con_eet_data_callback_add(Ecore_Con_Eet *ece, const char *name, Ecore_Con_Eet_Data_Cb func, const void *data);
151 151
152/** 152/**
153 * Remove a data callback on a Ecore_Con_Eet object. 153 * @brief Removes a data callback on a Ecore_Con_Eet object.
154 * 154 *
155 * @param ece An Ecore_Con_Eet object. 155 * @param ece An Ecore_Con_Eet object.
156 * @param name The name of the Eet stream to remove callback on. 156 * @param name The name of the Eet stream to remove callback on.
@@ -159,7 +159,7 @@ EAPI void ecore_con_eet_data_callback_add(Ecore_Con_Eet *ece, const char *name,
159EAPI void ecore_con_eet_data_callback_del(Ecore_Con_Eet *ece, const char *name); 159EAPI void ecore_con_eet_data_callback_del(Ecore_Con_Eet *ece, const char *name);
160 160
161/** 161/**
162 * Register a raw data callback on a Ecore_Con_Eet object. 162 * @brief Registers a raw data callback on a Ecore_Con_Eet object.
163 * When the Ecore_Con_Eet object is deleted, this automatically gets removed. 163 * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
164 * 164 *
165 * @param ece An Ecore_Con_Eet object. 165 * @param ece An Ecore_Con_Eet object.
@@ -171,7 +171,7 @@ EAPI void ecore_con_eet_data_callback_del(Ecore_Con_Eet *ece, const char *name);
171EAPI void ecore_con_eet_raw_data_callback_add(Ecore_Con_Eet *ece, const char *name, Ecore_Con_Eet_Raw_Data_Cb func, const void *data); 171EAPI void ecore_con_eet_raw_data_callback_add(Ecore_Con_Eet *ece, const char *name, Ecore_Con_Eet_Raw_Data_Cb func, const void *data);
172 172
173/** 173/**
174 * Remove a raw data callback on a Ecore_Con_Eet object. 174 * @brief Removes a raw data callback on a Ecore_Con_Eet object.
175 * 175 *
176 * @param ece An Ecore_Con_Eet object. 176 * @param ece An Ecore_Con_Eet object.
177 * @param name The name of the raw Eet stream to remove callback on. 177 * @param name The name of the raw Eet stream to remove callback on.
@@ -180,7 +180,7 @@ EAPI void ecore_con_eet_raw_data_callback_add(Ecore_Con_Eet *ece, const char *na
180EAPI void ecore_con_eet_raw_data_callback_del(Ecore_Con_Eet *ece, const char *name); 180EAPI void ecore_con_eet_raw_data_callback_del(Ecore_Con_Eet *ece, const char *name);
181 181
182/** 182/**
183 * Register a client connect callback on a Ecore_Con_Eet object. 183 * @brief Registers a client connect callback on a Ecore_Con_Eet object.
184 * @brief This callback can be registered on the server program to know when a 184 * @brief This callback can be registered on the server program to know when a
185 * client connects. 185 * client connects.
186 * When the Ecore_Con_Eet object is deleted, this automatically gets removed. 186 * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
@@ -192,7 +192,7 @@ EAPI void ecore_con_eet_raw_data_callback_del(Ecore_Con_Eet *ece, const char *na
192EAPI void ecore_con_eet_client_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data); 192EAPI void ecore_con_eet_client_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data);
193 193
194/** 194/**
195 * Remove a client connect callback on a Ecore_Con_Eet object. 195 * @brief Removes a client connect callback on a Ecore_Con_Eet object.
196 * 196 *
197 * @param ece An Ecore_Con_Eet object. 197 * @param ece An Ecore_Con_Eet object.
198 * @param func The callback to remove. 198 * @param func The callback to remove.
@@ -201,7 +201,7 @@ EAPI void ecore_con_eet_client_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Co
201EAPI void ecore_con_eet_client_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data); 201EAPI void ecore_con_eet_client_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data);
202 202
203/** 203/**
204 * Register a client disconnect callback on a Ecore_Con_Eet object. 204 * @brief Registers a client disconnect callback on a Ecore_Con_Eet object.
205 * @brief This callback can be registered on the server program to know when a 205 * @brief This callback can be registered on the server program to know when a
206 * client disconnects. 206 * client disconnects.
207 * When the Ecore_Con_Eet object is deleted, this automatically gets removed. 207 * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
@@ -213,7 +213,7 @@ EAPI void ecore_con_eet_client_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Co
213EAPI void ecore_con_eet_client_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data); 213EAPI void ecore_con_eet_client_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data);
214 214
215/** 215/**
216 * Remove a client disconnect callback on a Ecore_Con_Eet object. 216 * @brief Removes a client disconnect callback on a Ecore_Con_Eet object.
217 * 217 *
218 * @param ece An Ecore_Con_Eet object. 218 * @param ece An Ecore_Con_Eet object.
219 * @param func The callback to remove. 219 * @param func The callback to remove.
@@ -222,8 +222,8 @@ EAPI void ecore_con_eet_client_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore
222EAPI void ecore_con_eet_client_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data); 222EAPI void ecore_con_eet_client_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data);
223 223
224/** 224/**
225 * Register a server connect callback on a Ecore_Con_Eet object. 225 * @brief Registers a server connect callback on a Ecore_Con_Eet object.
226 * @brief This callback can be registered on the client program to be called 226 * @brief This callback can be registered on the client program to be called.
227 * when it has been connected to the server. 227 * when it has been connected to the server.
228 * When the Ecore_Con_Eet object is deleted, this automatically gets removed. 228 * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
229 * 229 *
@@ -234,7 +234,7 @@ EAPI void ecore_con_eet_client_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore
234EAPI void ecore_con_eet_server_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data); 234EAPI void ecore_con_eet_server_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data);
235 235
236/** 236/**
237 * Remove a server connect callback on a Ecore_Con_Eet object. 237 * @brief Removes a server connect callback on a Ecore_Con_Eet object.
238 * 238 *
239 * @param ece An Ecore_Con_Eet object. 239 * @param ece An Ecore_Con_Eet object.
240 * @param func The callback to remove. 240 * @param func The callback to remove.
@@ -243,7 +243,7 @@ EAPI void ecore_con_eet_server_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Co
243EAPI void ecore_con_eet_server_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data); 243EAPI void ecore_con_eet_server_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data);
244 244
245/** 245/**
246 * Register a server disconnect callback on a Ecore_Con_Eet object. 246 * @brief Registers a server disconnect callback on a Ecore_Con_Eet object.
247 * @brief This callback can be registered on the client program to be called 247 * @brief This callback can be registered on the client program to be called
248 * when it has been disconnected from the server. 248 * when it has been disconnected from the server.
249 * When the Ecore_Con_Eet object is deleted, this automatically gets removed. 249 * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
@@ -255,7 +255,7 @@ EAPI void ecore_con_eet_server_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Co
255EAPI void ecore_con_eet_server_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data); 255EAPI void ecore_con_eet_server_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data);
256 256
257/** 257/**
258 * Remove a server disconnect callback on a Ecore_Con_Eet object. 258 * @brief Removes a server disconnect callback on a Ecore_Con_Eet object.
259 * 259 *
260 * @param ece An Ecore_Con_Eet object. 260 * @param ece An Ecore_Con_Eet object.
261 * @param func The callback to remove. 261 * @param func The callback to remove.
@@ -264,7 +264,7 @@ EAPI void ecore_con_eet_server_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore
264EAPI void ecore_con_eet_server_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data); 264EAPI void ecore_con_eet_server_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data);
265 265
266/** 266/**
267 * Attach data to an Ecore_Con_Eet object. 267 * @brief Attaches data to an Ecore_Con_Eet object.
268 * 268 *
269 * @param ece An Ecore_Con_Eet object. 269 * @param ece An Ecore_Con_Eet object.
270 * @param data The data to attach to the Ecore_Con_Eet object. 270 * @param data The data to attach to the Ecore_Con_Eet object.
@@ -272,7 +272,7 @@ EAPI void ecore_con_eet_server_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore
272EAPI void ecore_con_eet_data_set(Ecore_Con_Eet *ece, const void *data); 272EAPI void ecore_con_eet_data_set(Ecore_Con_Eet *ece, const void *data);
273 273
274/** 274/**
275 * Get the data attached to an Ecore_Con_Eet object. 275 * @brief Gets the data attached to an Ecore_Con_Eet object.
276 * 276 *
277 * @param ece An Ecore_Con_Eet object. 277 * @param ece An Ecore_Con_Eet object.
278 * @return The data attached to the Ecore_Con_Eet object. 278 * @return The data attached to the Ecore_Con_Eet object.
@@ -280,7 +280,7 @@ EAPI void ecore_con_eet_data_set(Ecore_Con_Eet *ece, const void *data);
280EAPI const void *ecore_con_eet_data_get(Ecore_Con_Eet *ece); 280EAPI const void *ecore_con_eet_data_get(Ecore_Con_Eet *ece);
281 281
282/** 282/**
283 * Get the Ecore_Con_Eet object corresponding to the Ecore_Con_Reply object. 283 * @brief Gets the Ecore_Con_Eet object corresponding to the Ecore_Con_Reply object.
284 * 284 *
285 * @param reply An Ecore_Con_Reply object. 285 * @param reply An Ecore_Con_Reply object.
286 * @return The corresponding Ecore_Con_Eet object. 286 * @return The corresponding Ecore_Con_Eet object.
@@ -288,7 +288,7 @@ EAPI const void *ecore_con_eet_data_get(Ecore_Con_Eet *ece);
288EAPI Ecore_Con_Eet *ecore_con_eet_reply(Ecore_Con_Reply *reply); 288EAPI Ecore_Con_Eet *ecore_con_eet_reply(Ecore_Con_Reply *reply);
289 289
290/** 290/**
291 * Send some data using a protocol type. 291 * @brief Sends some data using a protocol type.
292 * 292 *
293 * @param reply An Ecore_Con_Reply object. 293 * @param reply An Ecore_Con_Reply object.
294 * @param protocol_name The protocol type to use. 294 * @param protocol_name The protocol type to use.
@@ -297,7 +297,7 @@ EAPI Ecore_Con_Eet *ecore_con_eet_reply(Ecore_Con_Reply *reply);
297EAPI void ecore_con_eet_send(Ecore_Con_Reply *reply, const char *protocol_name, void *value); 297EAPI void ecore_con_eet_send(Ecore_Con_Reply *reply, const char *protocol_name, void *value);
298 298
299/** 299/**
300 * Send some raw data using a protocol type. 300 * @brief Sends some raw data using a protocol type.
301 * 301 *
302 * @param reply An Ecore_Con_Reply object. 302 * @param reply An Ecore_Con_Reply object.
303 * @param protocol_name The protocol type to use. 303 * @param protocol_name The protocol type to use.
Copyright © Enlightenment.org