Net_SMPP
[ class tree: Net_SMPP ] [ index: Net_SMPP ] [ all elements ]

Class: Net_SMPP_Command_Data_Sm

Source Location: /Net_SMPP-0.4.5/Net/SMPP/Command/data_sm.php

Class Overview

Net_SMPP_PDU
   |
   --Net_SMPP_Command
      |
      --Net_SMPP_Command_Data_Sm

data_sm class


Author(s):

Version:

  • CVS: $Revision: 298083 $

Copyright:

  • Portions of the documentation (c) Copyright 1999 SMPP Developers Forum.

Variables


Inherited Variables

Inherited Methods

Class: Net_SMPP_Command

Net_SMPP_Command::Net_SMPP_Command()
4.x constructor
Net_SMPP_Command::__construct()
5.x/main constructor
Net_SMPP_Command::commandCode()
Get the ID of a command from it's name
Net_SMPP_Command::commandName()
Get the name of a command from it's ID
Net_SMPP_Command::fieldExists()
Does this field exist?
Net_SMPP_Command::fieldIsOptional()
Is this field optional?
Net_SMPP_Command::generateParams()
Generate the binary data from the object
Net_SMPP_Command::isFixed()
Is this a fixed-length field?
Net_SMPP_Command::parseOptionalParams()
Parse optional paramaters
Net_SMPP_Command::parseParams()
Parse data into the object structure
Net_SMPP_Command::set()
Set values in this object
Net_SMPP_Command::_commandList()
Get the list of SMPP v3.4 commands
Net_SMPP_Command::_optionalParams()
Get list of optional paramaters

Class: Net_SMPP_PDU

Net_SMPP_PDU::extractCommand()
Extract the command from a PDU
Net_SMPP_PDU::factory()
Get an instance of a specific command class
Net_SMPP_PDU::generate()
Generate the raw PDU to send to the remote system
Net_SMPP_PDU::isError()
Is this an error response?
Net_SMPP_PDU::isRequest()
Is this a request PDU?
Net_SMPP_PDU::isResponse()
Is this a response PDU?
Net_SMPP_PDU::isVendor()
Is this a vendor PDU?
Net_SMPP_PDU::parse()
Parse a raw PDU and populate this instance with it's data
Net_SMPP_PDU::statusDesc()
Get status description

Class Details

[line 68]
data_sm class

This command is used to transfer data between the SMSC and the ESME. It may be used by both the ESME and SMSC.

This command is an alternative to the submit_sm and deliver_sm commands. It is introduced as a new command to be used by interactive applications such as those provided via a WAP framework.

The ESME may use this command to request the SMSC to transfer a message to an MS. The SMSC may also use this command to transfer an MS originated message to an ESME.

In addition, the data_sm operation can be used to transfer the following types of special messages to the ESME:-

  • SMSC Delivery Receipt.
  • SME Delivery Acknowledgement. The user data of the SME delivery acknowledgement is included in the short_message field of the data_sm
  • SME Manual/User Acknowledgement. The user data of the SME delivery acknowledgement is included in the short_message field of the data_sm
  • Intermediate Notification.

  • Author: Ian Eure <ieure@php.net>
  • Version: Release: @package_version@
  • Version: CVS: $Revision: 298083 $
  • Copyright: (c) Copyright 2005 WebSprockets, LLC.
  • Copyright: Portions of the documentation (c) Copyright 1999 SMPP Developers Forum.
  • Link: http://pear.php.net/package/Net_SMPP
  • Since: Release 0.3.8
  • License: PHP License 3.0


[ Top ]


Class Variables

$alert_on_msg_delivery =

[line 154]


Type:   mixed


[ Top ]

$callback_num =

[line 143]


Type:   mixed


[ Top ]

$callback_num_atag =

[line 145]


Type:   mixed


[ Top ]

$callback_num_pres_ind =

[line 144]


Type:   mixed


[ Top ]

$data_coding =

[line 118]

  • See: Net_SMPP_Command_submit_sm::$data_coding

Type:   mixed


[ Top ]

$destination_addr =

[line 103]

  • See: Net_SMPP_Command_submit_sm::$destination_addr

Type:   mixed


[ Top ]

$destination_port =

[line 126]


Type:   mixed


[ Top ]

$dest_addr_npi =

[line 98]

  • See: Net_SMPP_Command_submit_sm::$dest_addr_npi

Type:   mixed


[ Top ]

$dest_addr_subunit =

[line 127]


Type:   mixed


[ Top ]

$dest_addr_ton =

[line 93]

  • See: Net_SMPP_Command_submit_sm::$dest_addr_ton

Type:   mixed


[ Top ]

$dest_bearer_type =

[line 129]


Type:   mixed


[ Top ]

$dest_network_type =

[line 128]


Type:   mixed


[ Top ]

$dest_subaddress =

[line 147]


Type:   mixed


[ Top ]

$dest_telematics_id =

[line 130]


Type:   mixed


[ Top ]

$display_time =

[line 149]


Type:   mixed


[ Top ]

$esm_class =

[line 108]

  • See: Net_SMPP_Command_submit_sm::$esm_class

Type:   mixed


[ Top ]

$its_reply_type =

[line 156]


Type:   mixed


[ Top ]

$its_session_info =

[line 157]


Type:   mixed


[ Top ]

$language_indicator =

[line 155]


Type:   mixed


[ Top ]

$message_payload =

[line 137]


Type:   mixed


[ Top ]

$message_state =

[line 139]


Type:   mixed


[ Top ]

$more_messages_to_send =

[line 134]


Type:   mixed


[ Top ]

$ms_msg_wait_facilities =

[line 152]


Type:   mixed


[ Top ]

$ms_validity =

[line 151]


Type:   mixed


[ Top ]

$network_error_code =

[line 140]


Type:   mixed


[ Top ]

$number_of_messages =

[line 153]


Type:   mixed


[ Top ]

$payload_type =

[line 136]


Type:   mixed


[ Top ]

$privacy_indicator =

[line 142]


Type:   mixed


[ Top ]

$qos_time_to_live =

[line 135]


Type:   mixed


[ Top ]

$receipted_message_id =

[line 138]


Type:   mixed


[ Top ]

$registered_delivery =

[line 113]

  • See: Net_SMPP_Command_submit_sm::$registered_delivery

Type:   mixed


[ Top ]

$sar_msg_ref_num =

[line 131]


Type:   mixed


[ Top ]

$sar_segment_seqnum =

[line 133]


Type:   mixed


[ Top ]

$sar_total_segments =

[line 132]


Type:   mixed


[ Top ]

$service_type =

[line 73]

  • See: Net_SMPP_Command_submit_sm::$service_type

Type:   mixed


[ Top ]

$sms_signal =

[line 150]


Type:   mixed


[ Top ]

$source_addr =

[line 88]

  • See: Net_SMPP_Command_submit_sm::$source_addr

Type:   mixed


[ Top ]

$source_addr_npi =

[line 83]

  • See: Net_SMPP_Command_submit_sm::$source_addr_npi

Type:   mixed


[ Top ]

$source_addr_subunit =

[line 122]


Type:   mixed


[ Top ]

$source_addr_ton =

[line 78]

  • See: Net_SMPP_Command_submit_sm::$source_addr_ton

Type:   mixed


[ Top ]

$source_bearer_type =

[line 124]


Type:   mixed


[ Top ]

$source_network_type =

[line 123]


Type:   mixed


[ Top ]

$source_port =

[line 121]


Type:   mixed


[ Top ]

$source_subaddress =

[line 146]


Type:   mixed


[ Top ]

$source_telematics_id =

[line 125]


Type:   mixed


[ Top ]

$user_message_reference =

[line 141]


Type:   mixed


[ Top ]

$user_response_code =

[line 148]


Type:   mixed


[ Top ]

$_defs = array(
        'service_type' => array(
            'type' => 'string',
            'max' => 6
        ),'source_addr_ton'=>array('type'=>'int','size'=>1,),'source_addr_npi'=>array('type'=>'int','size'=>1),'source_addr'=>array('type'=>'string','max'=>21,),'dest_addr_ton'=>array('type'=>'int','size'=>1,),'dest_addr_npi'=>array('type'=>'int','size'=>1,),'destination_addr'=>array('type'=>'string','max'=>21),'esm_class'=>array('type'=>'int','size'=>1),'registered_delivery'=>array('type'=>'int','size'=>1,),'data_coding'=>array('type'=>'int','size'=>1),// Optional params
'source_port'=>array('type'=>'int','size'=>2),'source_addr_subunit'=>array('type'=>'int','size'=>1),'source_network_type'=>array('type'=>'int','size'=>1),'source_bearer_type'=>array('type'=>'int','size'=>1),'source_telematics_id'=>array('type'=>'int','size'=>2),'destination_port'=>array('type'=>'int','size'=>2),'dest_addr_subunit'=>array('type'=>'int','size'=>1),'dest_network_type'=>array('type'=>'int','size'=>1),'dest_bearer_type'=>array('type'=>'int','size'=>1),'dest_telematics_id'=>array('type'=>'int','size'=>2),'sar_msg_ref_num'=>array('type'=>'int','size'=>2),'sar_total_segments'=>array('type'=>'int','size'=>1),'sar_segment_seqnum'=>array('type'=>'int','size'=>1),'more_messages_to_send'=>array('type'=>'int','size'=>1),'qos_time_to_live'=>array('type'=>'int','size'=>4),'payload_type'=>array('type'=>'int','size'=>1),'message_payload'=>array('type'=>'ostring','max'=>260),'receipted_message_id'=>array('type'=>'string','max'=>65),'message_state'=>array('type'=>'int','size'=>1),'network_error_code'=>array('type'=>'ostring','size'=>3),'user_message_reference'=>array('type'=>'int','size'=>2),'privacy_indicator'=>array('type'=>'int','size'=>1),'callback_num'=>array('type'=>'sting','min'=>4,'max'=>19),'callback_num_pres_ind'=>array('type'=>'int','size'=>1),'callback_num_atag'=>array('type'=>'string','max'=>65),'source_subaddress'=>array('type'=>'string','min'=>2,'max'=>23),'dest_subaddress'=>array('type'=>'string','min'=>2,'max'=>23),'user_response_code'=>array('type'=>'int','size'=>1),'display_time'=>array('type'=>'int','size'=>1),'sms_signal'=>array('type'=>'int','size'=>2),'ms_validity'=>array('type'=>'int','size'=>1),'ms_msg_wait_facilities'=>array('type'=>'int','size'=>1),'number_of_messages'=>array('type'=>'int','size'=>1),'alert_on_msg_delivery'=>array('type'=>'flag'),'language_indicator'=>array('type'=>'int','size'=>1),'its_reply_type'=>array('type'=>'int','size'=>1),'its_session_info'=>array('type'=>'int','size'=>2))

[line 166]

Paramater definitions for this command

Type:   array
Overrides:   Array


[ Top ]



Documentation generated on Tue, 01 Jun 2010 10:30:05 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.