Class: WampClient::Message::Cancel

Inherits:
Base
  • Object
show all
Defined in:
lib/wamp_client/message.rb

Overview

Cancel The “CANCEL” message is used with the Call Canceling advanced feature. A Caller can cancel and issued call actively by sending a cancel message to the Dealer. Formats:

[CANCEL, CALL.Request|id, Options|dict]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Check

included

Constructor Details

#initialize(call_request, options) ⇒ Cancel

Returns a new instance of Cancel.



1226
1227
1228
1229
1230
1231
1232
1233
1234
 
# File 'lib/wamp_client/message.rb', line 1226

def initialize(call_request, options)

  self.class.check_id('call_request', call_request)
  self.class.check_dict('options', options)

  self.call_request = call_request
  self.options = options

end

Instance Attribute Details

#call_request ⇒ Object

Returns the value of attribute call_request.



1224
1225
1226
 
# File 'lib/wamp_client/message.rb', line 1224

def call_request
  @call_request
end

#options ⇒ Object

Returns the value of attribute options.



1224
1225
1226
 
# File 'lib/wamp_client/message.rb', line 1224

def options
  @options
end

Class Method Details

.parse(params) ⇒ Object 



1240
1241
1242
1243
1244
1245
1246
1247
1248
 
# File 'lib/wamp_client/message.rb', line 1240

def self.parse(params)

  self.check_gte('params list', 3, params.count)
  self.check_equal('message type', self.type, params[0])

  params.shift
  self.new(*params)

end

.type ⇒ Object 



1236
1237
1238
 
# File 'lib/wamp_client/message.rb', line 1236

def self.type
  Types::CANCEL
end

Instance Method Details

#payload ⇒ Object 



1250
1251
1252
1253
1254
1255
1256
 
# File 'lib/wamp_client/message.rb', line 1250

def payload
  payload = [self.class.type]
  payload.push(self.call_request)
  payload.push(self.options)

  payload
end

#to_s ⇒ Object 



1258
1259
1260
 
# File 'lib/wamp_client/message.rb', line 1258

def to_s
  'CANCEL > ' + self.payload.to_s
end