summaryrefslogtreecommitdiffstats
path: root/lib/edoors/door.rb
blob: 553cb882b9707ddab8b19797e8dc28a38036b24b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
#! /usr/bin/env ruby
# -*- coding: UTF-8 -*-
#
# Copyright 2012 Jérémy Zurcher <jeremy@asynk.ch>
#
# This file is part of edoors-ruby.
#
# edoors-ruby is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# edoors-ruby 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with edoors-ruby.  If not, see <http://www.gnu.org/licenses/>.

#
module Edoors
    #
    class Door < Iota
        #
        # creates a Door object from the arguments.
        #
        # @param [String] n the name of this Door
        # @param [Iota] p the parent
        #
        def initialize n, p
            super n, p
            @saved = nil
        end
        #
        # called by JSON#generate to serialize the Door object into JSON data
        #
        # @param [Array] a belongs to JSON generator
        #
        def to_json *a
            {
                'kls'   => self.class.name,
                'name'  => @name
            }.merge(hibernate!).to_json *a
        end
        #
        # creates a Door object from a JSON data
        #
        # @param [Hash] o belongs to JSON parser
        #
        # @raise Edoors::Exception if the json kls attribute is wrong
        #
        def self.json_create o
            raise Edoors::Exception.new "JSON #{o['kls']} != #{self.name}" if o['kls'] != self.name
            door = self.new o['name'], o['parent']
            door.resume! o
            door
        end
        #
        # require a Particle of the given class
        #
        # @param [Class] p_kls the class of the desired Particle
        #
        def require_p p_kls=Edoors::Particle
            @spin.require_p p_kls
        end
        #
        # release the given Particle
        #
        # @param [Particle] p the Particle to be released
        #
        def release_p p
            @saved=nil if @saved==p     # particle is released, all is good
            @spin.release_p p
        end
        #
        # release the Particle that have not been released or sent by user code
        #
        def _garbage
            puts " ! #{path} didn't give back #{@saved}" if @spin.debug_garbage
            puts "\t#{@saved.data Edoors::FIELD_ERROR_MSG}" if @saved.action==Edoors::ACT_ERROR
            @spin.release_p @saved
            @saved = nil
        end
        private :_garbage
        #
        # process the given particle then forward it to user code
        #
        # @param [Particle] p the Particle to be forwarded to user code
        #
        def process_p p
            @viewer.receive_p p if @viewer
            @saved = p
            receive_p p
            _garbage if not @saved.nil?
        end
        #
        # dead end, for now user defined Door do not have to deal with system Particle
        # the Particle is released
        #
        # @param [Particle] p the Particle to deal with
        #
        def process_sys_p p
            # nothing todo with it now
            @spin.release_p p
        end
        #
        # send the given Particle through the direct @parent
        #
        # @param [Particle] p the Particle to be sent
        # @param [Boolean] sys if true send to system Particle fifo
        # @param [String] a the post action
        # @param [Iota] d the post destination
        #
        def _send p, sys, a, d
            p.init! self
            p.set_dst! a, d||self if a
            @saved=nil if @saved==p # particle is sent back the data, all is good
            # daddy will know what to do
            sys ? @parent.send_sys_p(p) : @parent.send_p(p)
        end
        private :_send
        #
        # send the given Particle to the user fifo
        #
        # @param [Particle] p the Particle to be sent
        # @param [String] a the post action
        # @param [Iota] d the post destination
        #
        # @see Door#_send real implementation
        #
        def send_p p, a=nil, d=nil
            _send p, false, a, d
        end
        #
        # send the given Particle to the system fifo
        #
        # @param [Particle] p the Particle to be sent
        # @param [String] a the post action
        # @param [Iota] d the post destination
        #
        # @see Door#_send real implementation
        #
        def send_sys_p p, a=nil, d=nil
            _send p, true, a, d
        end
        #
    end
    #
end
#
# EOF