Class: Majoron::AntHill::SMPP::SMPPQueryBroadcastSM

Inherits:
SMPPPDU
  • Object
show all
Defined in:
lib/pdu/smpp_query_broadcast_sm.rb

Instance Attribute Summary collapse

Attributes inherited from SMPPPDU

#header

Instance Method Summary collapse

Methods inherited from SMPPPDU

#command_id, #command_length, #command_status, #command_status=, #sequence_number, #sequence_number=

Constructor Details

#initialize(command_status = ErrorCode::ESME_ROK, sequence_number = nil) ⇒ SMPPQueryBroadcastSM

Returns a new instance of SMPPQueryBroadcastSM.



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/pdu/smpp_query_broadcast_sm.rb', line 23

def initialize(command_status = ErrorCode::ESME_ROK, sequence_number = nil)
	super(CommandId::CM_QUERY_BROADCAST_SM, command_status, sequence_number)
  
	# Mandatory fields
	@message_id = ""
	@source_addr_ton = TON::UNKNOWN
	@source_addr_npi = TON::UNKNOWN
	@source_addr = ""
  
	# Optional fields
	@user_message_reference = nil

	# Optional fields length
	@user_message_reference_len = SMPPTLVLen::WORD_LEN
  
end

Instance Attribute Details

#message_id ⇒ Object

Mandatory fields



106
107
108
 
# File 'lib/pdu/smpp_query_broadcast_sm.rb', line 106

def message_id
  @message_id
end

#source_addr ⇒ Object

Returns the value of attribute source_addr.



109
110
111
 
# File 'lib/pdu/smpp_query_broadcast_sm.rb', line 109

def source_addr
  @source_addr
end

#source_addr_npi ⇒ Object

Returns the value of attribute source_addr_npi.



108
109
110
 
# File 'lib/pdu/smpp_query_broadcast_sm.rb', line 108

def source_addr_npi
  @source_addr_npi
end

#source_addr_ton ⇒ Object

Returns the value of attribute source_addr_ton.



107
108
109
 
# File 'lib/pdu/smpp_query_broadcast_sm.rb', line 107

def source_addr_ton
  @source_addr_ton
end

#user_message_reference ⇒ Object

Optional fields



112
113
114
 
# File 'lib/pdu/smpp_query_broadcast_sm.rb', line 112

def user_message_reference
  @user_message_reference
end

#user_message_reference_len ⇒ Object

Optional fields length



115
116
117
 
# File 'lib/pdu/smpp_query_broadcast_sm.rb', line 115

def user_message_reference_len
  @user_message_reference_len
end

Instance Method Details

#decode_packet(decoder) ⇒ Object

Interface to decode SMPP packet



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/pdu/smpp_query_broadcast_sm.rb', line 55

def decode_packet(decoder)
	# Decode header and mandatory fields
	@header = decoder.decode_header()
	@message_id = decoder.decode_message_id(command_length())
	@source_addr_ton = decoder.decode_source_addr_ton(command_length())
	@source_addr_npi = decoder.decode_source_addr_npi(command_length())
	@source_addr = decoder.decode_source_addr21(command_length())
  
	# Decode optional fields
	while decoder.has_tlvs() 
		case decoder.get_tlv_code()
			when OptTags::TAG_USER_MESSAGE_REFERENCE
				@user_message_reference, @user_message_reference_len = 
					decoder.decode_user_message_reference(command_length())
			else
				# Report about error
				raise Errors::UNKNOWN_TAG_MSG + decoder.get_tlv_error()
		end
	end
end

#encode_packet(encoder) ⇒ Object

Interface to encode SMPP packet



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/pdu/smpp_query_broadcast_sm.rb', line 41

def encode_packet(encoder)
	# Encode header and mandatory fields
	encoder.encode_header(@header)
	encoder.encode_message_id(@message_id)
	encoder.encode_source_addr_ton(@source_addr_ton)
	encoder.encode_source_addr_npi(@source_addr_npi)
	encoder.encode_source_addr21(@source_addr)
  
	# Encode optional fields
	encoder.encode_user_message_reference(@user_message_reference, 
		@user_message_reference_len) if !@user_message_reference.nil?
end

#output_packet(outputter) ⇒ Object

Interface to output SMPP packet



91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/pdu/smpp_query_broadcast_sm.rb', line 91

def output_packet(outputter)
	# Output header and mandatory fields
	outputter.output_header(@header)
	outputter.output_message_id(@message_id)
	outputter.output_source_addr_ton(@source_addr_ton)
	outputter.output_source_addr_npi(@source_addr_npi)
	outputter.output_source_addr21(@source_addr)
  
	# Encode optional fields
	outputter.output_user_message_reference(@user_message_reference, 
		@user_message_reference_len) if !@user_message_reference.nil?
end

#validate_packet(validator) ⇒ Object

Interface to validate SMPP packet



77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/pdu/smpp_query_broadcast_sm.rb', line 77

def validate_packet(validator)
	# Validate header and mandatory fields
	validator.validate_header(@header)
	validator.validate_message_id(@message_id)
	validator.validate_source_addr_ton(@source_addr_ton)
	validator.validate_source_addr_npi(@source_addr_npi)
	validator.validate_source_addr21(@source_addr)
  
	# Encode optional fields
	validator.validate_user_message_reference(@user_message_reference, 
		@user_message_reference_len) if !@user_message_reference.nil?
end