summaryrefslogtreecommitdiff
path: root/src/modules/dummy.lua
blob: b91ddf38abc1ab9974397223e4bf689871d91709 (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
--
--  gcsd
--
--  gcsd the generic command sequencer daemon can be used to serialize
--  commands sent over various paralell communication channels to a
--  single command output. It can be seen as a multiplexer for any
--  kind of communication between a single resource and various clients
--  which want to submit commands to it or query information from it.
--  gcsd is written in C and Lua. The goal is to provide an easy to
--  understand high level API based on Lua which can be used to
--  implement the business logic of the so formed multiplexer daemon.
--
--
--  Copyright (C) 2009-2010 Markus Grueneis <gimpf@spreadspace.org>
--                          Christian Pointner <equinox@spreadspace.org>
--
--  This file is part of gcsd.
--
--  gcsd is free software: you can redistribute it and/or modify
--  it under the terms of the GNU General Public License as published by
--  the Free Software Foundation, either version 3 of the License, or
--  any later version.
--
--  gcsd is distributed in the hope that it will be useful,
--  but WITHOUT ANY WARRANTY; without even the implied warranty of
--  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
--  GNU General Public License for more details.
--
--  You should have received a copy of the GNU General Public License
--  along with gcsd. If not, see <http://www.gnu.org/licenses/>.
--

-- dummy module class
local dummy = {}
dummy.properties = { type=defines.INOUT_MODULE, name="dummy", max_instances=-1 }
dummy.next_id = 0

-- create new instance of dummy module class
function dummy:new(config, runtype)
   local inst = {}
   inst.class = self
   inst.config = config
   if(config.name == nil or config.name == "") then
      inst.name = self.properties.name .. self.next_id
      self.next_id = self.next_id + 1
   else
      inst.name = config.name
   end

   local handle = {}
   handle.fd = 0
   handle.client_instance = nil
   function handle:read() end
   function handle:write() end

   local client = {}
   client.module_instance = inst
   client.name = inst.name .. "#0"
   function client:process_response(response) end
   function client:process_timeout() end
   function client:get_read_handles() return handle end
   function client:get_write_handles() return {} end
   function client:cleanup() end
   handle.client_instance = client

   function inst:cleanup()
      client_list:unregister_by_module(self)
   end
   function inst:get_read_handles()
      return {}
   end
   function inst:get_write_handles()
      return {}
   end
   function inst:start_command(command)
   end
   setmetatable(inst, {})
   getmetatable(inst).__gc = function() inst:cleanup() end

   client_list:register(client)
   return inst
end

return dummy