aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/ecore_con/ecore_con_eet_base.eo
blob: fcbc83574f5d161ce3b579fdf39fefeada6f41ac (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
import efl_network_server;

type @extern Ecore_Con_Eet_Data_Cb: __undefined_type; [[Ecore connection eet data callback type]] /* FIXME: function pointers not supported. */
type @extern Ecore_Con_Eet_Raw_Data_Cb: __undefined_type; [[Ecore connection eet raw data callback type]]/* FIXME: function pointers not supported. */

struct @extern Eet.Data.Descriptor; [[Eet data descriptor data structure]]
struct Ecore.Con.Reply; [[Ecore connection reply data structure]]

class Ecore.Con.Eet.Base (Efl.Object) {
   [[Ecore Connection Eet Base class.
   
   This class provides Eet data serialization features to Ecore Connection objects.]]

   methods {
      @property server {
         [[The server object to which we send and receive.]]
         set {
         }
         get {
         }
         values {
            data: Efl.Network.Server; [[Server object]]
         }
      }
      @property data_callback {
         [[A callback function which should be called when data is
           received by ecore_con_eet_object.]]
         set {
         }
         values {
            name: string; [[The name of the eet stream.]]
            func: Ecore_Con_Eet_Data_Cb; [[The callback function.]]
            data: const(void_ptr); [[The data (if any) that should be
                                    passed to callback function.]]
         }
      }
      @property raw_data_callback {
         [[A callback function which should be calledn when raw data
           is received by ecore_con_eet_object.]]
         set {
         }
         values {
            name: string; [[The name of the eet stream.]]
            func: Ecore_Con_Eet_Raw_Data_Cb; [[The callback function.]]
            data: const(void_ptr); [[The data (if any) that should be
                                    passed to callback function.]]
         }
      }
      data_callback_del {
         [[Function to delete the @.data_callback.]]
         params {
            name: string; [[The name of the eet stream.]]
         }
      }
      raw_data_callback_del {
         [[Function to delete the @.raw_data_callback.]]
         params {
            name: string; [[The name of the eet stream.]]
         }
      }
      register {
         [[Function to register a \@ref Eet.Data.Descriptor to the
           ecore_con_eet object.]]
         legacy: ecore_con_eet;
         params {
            name: string; [[The name of the eet stream.]]
            edd: ptr(Eet.Data.Descriptor); [[The Eet.Data.Descriptor that
                                             is to be registered.]]
         }
      }
      send {
         [[Function to send data.]]
         params {
            reply: ptr(Ecore.Con.Reply); [[Contains the ecore_con_eet object
                                           to which the data has to be sent.]]
            name: string; [[The name of the eet stream.]]
            value: void_ptr; [[Actual data]]
         }
      }
      raw_send {
         [[Function to send raw data.]]
         params {
            reply: ptr(Ecore.Con.Reply); [[Contains the ecore_con_eet object
                                           to which the data has to be sent.]]
            protocol_name: string; [[The name of the eet stream.]]
            section: string; [[Name of section in the eet descriptor.]]
            value: void_ptr; [[The value of the section.]]
            length: uint; [[The length of the data that is being sent.]]
         }
      }
   }
   implements {
      Efl.Object.constructor;
      Efl.Object.destructor;
      Efl.Object.finalize;
   }
}