Class: PCP::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/pcp/client.rb

Overview

Manages a client connection to a pcp broker

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ Object

Construct a new disconnected client

Parameters:

  • params (Hash<Symbol,Object>) (defaults to: {})

73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/pcp/client.rb', line 73

def initialize(params = {})
  @server = params[:server] || 'wss://localhost:8142/pcp'
  @ssl_key = params[:ssl_key]
  @ssl_cert = params[:ssl_cert]
  @ssl_ca_cert = params[:ssl_ca_cert]
  @logger = params[:logger] || Logger.new(STDOUT)
  @logger.level = params[:loglevel] || Logger::WARN
  @connection = nil
  type = params[:type] || "ruby-pcp-client-#{$$}"
  @identity = make_identity(@ssl_cert, type)
  @on_message = params[:on_message]
  @max_message_size = params[:max_message_size] || 64*1024*1024
  @associated = false
end

Instance Attribute Details

#identityString

Read the @identity property

Returns:

  • (String)

60
61
62
# File 'lib/pcp/client.rb', line 60

def identity
  @identity
end

#on_messageProc

Set a proc that will be used to handle messages

Returns:

  • (Proc)

66
67
68
# File 'lib/pcp/client.rb', line 66

def on_message
  @on_message
end

Instance Method Details

#associated?true, false

Is the client associated with the server

Returns:

  • (true, false)

200
201
202
# File 'lib/pcp/client.rb', line 200

def associated?
  @associated
end

#closeObject

Disconnect the client

Returns:

  • unused


223
224
225
226
227
228
# File 'lib/pcp/client.rb', line 223

def close
  EM.next_tick do
    @logger.debug { [:close] }
    @connection.close
  end
end

#connect(seconds = 0) ⇒ true, ...

Connect to the server

Parameters:

  • seconds (Numeric) (defaults to: 0)

Returns:

  • (true, false, nil)

93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'lib/pcp/client.rb', line 93

def connect(seconds = 0)
  if @connection
    # We close over so much, we really just need to say no for now
    raise "Can only connect once per client"
  end

  mutex = Mutex.new
  associated_cv = ConditionVariable.new

  @logger.debug { [:connect, :scheduling] }
  EM.next_tick do
    @logger.debug { [:connect, @server] }

    start_tls_options = {
      :ssl_version => ["TLSv1", "TLSv1_1", "TLSv1_2"],
      :private_key_file => @ssl_key,
      :cert_chain_file => @ssl_cert,
      :verify_peer => true,
      :fail_if_no_peer_cert => true,
      # side-channeled properties we want around during ssl
      # verification are prefixed with xxx_.
      :xxx_logger => @logger,
      :xxx_ssl_ca_cert => @ssl_ca_cert,
      :xxx_hostname => URI.parse(@server).host,
    }

    @connection = Faye::WebSocket::Client.new(@server, nil, {:tls => start_tls_options,
                                                             :ping => 30,
                                                             :max_length => @max_message_size})

    @connection.on :open do |event|
      begin
        @logger.info { [:open] }
        send(associate_request)
      rescue Exception => e
        @logger.error { [:open_exception, e] }
      end
    end

    @connection.on :message do |event|
      begin
        message = ::PCP::Message.new(event.data)
        @logger.debug { [:message, :decoded, message] }

        if message[:message_type] == 'http://puppetlabs.com/associate_response'
          mutex.synchronize do
            @associated = JSON.load(message.data)["success"]
            associated_cv.signal
          end
        elsif @on_message
          @on_message.call(message)
        end
      rescue Exception => e
        @logger.error { [:message_exception, e] }
      end
    end

    @connection.on :close do |event|
      begin
        @logger.info { [:close, event.code, event.reason] }
        mutex.synchronize do
          @associated = false
          associated_cv.signal
        end
      rescue Exception => e
        @logger.error { [:close_exception, e] }
      end
    end

    @connection.on :error do |event|
      @logger.error { [:error, event] }
      @associated = false
    end
  end

  if !EM.reactor_running?
    @logger.debug { [:no_eventmachine_reactor,
                     "Eventmachine reactor is not running" ] }
    return nil
  end

  if EM.reactor_thread?
    # Because we use a condition variable to signal this thread
    # from the reactor thread to provide an imperative interface,
    # they cannot be the same thread.  We might associate later,
    # we just can't wait on ourselves from here.
    @logger.debug { [:connection_cannot_wait,
                    "Cannot wait on a connection if we are in the same thread as the reactor" ] }
    return nil
  end

  begin
    Timeout::timeout(seconds) do
      mutex.synchronize do
        associated_cv.wait(mutex)
        return @associated
      end
    end
  rescue Timeout::Error
    return nil
  end
end

#send(message) ⇒ Object

Send a message to the server

Parameters:

Returns:

  • unused


209
210
211
212
213
214
215
216
217
218
# File 'lib/pcp/client.rb', line 209

def send(message)
  EM.next_tick do
    @logger.debug { [:send, message] }
    if message[:expires].nil?
      message.expires(3)
    end
    message[:sender] = identity
    @connection.send(message.encode)
  end
end