PHP Class XMPPStream, JAXL

..
Author: abhinavsingh
Inheritance: extends JAXLFsm
Show file Open project: jaxl/JAXL Class Usage Examples

Public Properties

Property Type Description
$force_tls
$full_jid jid with binding resource value
$jid XMPPJid
$pass
$resource

Protected Properties

Property Type Description
$last_id stanza id
$trans JAXLClientBase Socket/BOSH reference.
$xml JAXLXmlStream XML stream reference.

Public Methods

Method Description
__construct ( JAXLClientBase $transport, XMPPJid | null $jid, string $pass = null, string $resource = null, boolean $force_tls = false )
__destruct ( )
connected ( $event, $args )
disconnected ( $event, $args )
encrypt_password ( $data, $user, $pass )
explode_data ( $data )
get_auth_pkt ( $mechanism, $user, $pass ) someday this all needs to go inside jaxl_sasl_auth
get_bind_pkt ( $resource )
get_challenge_response ( $decoded )
get_challenge_response_pkt ( $challenge )
get_compress_pkt ( $method )
get_end_stream ( )
get_id ( )
get_iq_pkt ( $attrs, $payload )
get_msg_pkt ( $attrs, $body = null, $thread = null, $subject = null, $payload = null )
get_pres_pkt ( $attrs, $status = null, $show = null, $priority = null, $payload = null )
get_session_pkt ( )
get_start_stream ( XMPPJid $jid )
get_starttls_pkt ( )
handle_auth_failure ( $reason )
handle_auth_mechs ( $stanza, $mechs )
handle_auth_success ( )
handle_invalid_state ( $r )
handle_iq ( $stanza )
handle_message ( $stanza )
handle_other ( $event, $args )
handle_presence ( $stanza )
handle_stream_start ( $stanza )
implode_data ( $data )
logged_in ( $event, $args )
logged_out ( $event, $args )
send ( JAXLXmlAccess $stanza )
send_end_stream ( )
send_raw ( string $data )
setup ( $event, $args )
wait_for_bind_response ( $event, $args )
wait_for_compression_result ( $event, $args )
wait_for_sasl_response ( $event, $args )
wait_for_session_response ( $event, $args )
wait_for_stream_features ( $event, $args ) XEP-0170: Recommended Order of Stream Feature Negotiation
wait_for_stream_start ( $event, $args )
wait_for_tls_result ( $event, $args )

Protected Methods

Method Description
send_auth_pkt ( $type, $user, $pass )
send_bind_pkt ( $resource )
send_challenge_response ( $challenge )
send_compress_pkt ( $method )
send_session_pkt ( )
send_start_stream ( XMPPJid $jid )
send_starttls_pkt ( )

Private Methods

Method Description
do_connect ( $args )

Method Details

__construct() public method

public __construct ( JAXLClientBase $transport, XMPPJid | null $jid, string $pass = null, string $resource = null, boolean $force_tls = false )
$transport JAXLClientBase
$jid XMPPJid | null
$pass string
$resource string
$force_tls boolean

__destruct() public method

public __destruct ( )

connected() public method

public connected ( $event, $args )

disconnected() public method

public disconnected ( $event, $args )

encrypt_password() public method

public encrypt_password ( $data, $user, $pass )

explode_data() public method

public explode_data ( $data )

get_auth_pkt() public method

someday this all needs to go inside jaxl_sasl_auth
public get_auth_pkt ( $mechanism, $user, $pass )

get_bind_pkt() public method

public get_bind_pkt ( $resource )

get_challenge_response() public method

public get_challenge_response ( $decoded )

get_challenge_response_pkt() public method

public get_challenge_response_pkt ( $challenge )

get_compress_pkt() public method

public get_compress_pkt ( $method )

get_end_stream() public method

public get_end_stream ( )

get_id() public method

public get_id ( )

get_iq_pkt() public method

public get_iq_pkt ( $attrs, $payload )

get_msg_pkt() public method

public get_msg_pkt ( $attrs, $body = null, $thread = null, $subject = null, $payload = null )

get_pres_pkt() public method

public get_pres_pkt ( $attrs, $status = null, $show = null, $priority = null, $payload = null )

get_session_pkt() public method

public get_session_pkt ( )

get_start_stream() public method

public get_start_stream ( XMPPJid $jid )
$jid XMPPJid

get_starttls_pkt() public method

public get_starttls_pkt ( )

handle_auth_failure() abstract public method

abstract public handle_auth_failure ( $reason )

handle_auth_mechs() abstract public method

abstract public handle_auth_mechs ( $stanza, $mechs )

handle_auth_success() abstract public method

abstract public handle_auth_success ( )

handle_invalid_state() public method

public handle_invalid_state ( $r )

handle_iq() abstract public method

abstract public handle_iq ( $stanza )

handle_message() abstract public method

abstract public handle_message ( $stanza )

handle_other() abstract public method

abstract public handle_other ( $event, $args )

handle_presence() abstract public method

abstract public handle_presence ( $stanza )

handle_stream_start() abstract public method

abstract public handle_stream_start ( $stanza )

implode_data() public method

public implode_data ( $data )

logged_in() public method

public logged_in ( $event, $args )

logged_out() public method

public logged_out ( $event, $args )

send() public method

public send ( JAXLXmlAccess $stanza )
$stanza JAXLXmlAccess

send_auth_pkt() protected method

protected send_auth_pkt ( $type, $user, $pass )

send_bind_pkt() protected method

protected send_bind_pkt ( $resource )

send_challenge_response() protected method

protected send_challenge_response ( $challenge )

send_compress_pkt() protected method

protected send_compress_pkt ( $method )

send_end_stream() public method

public send_end_stream ( )

send_raw() public method

public send_raw ( string $data )
$data string

send_session_pkt() protected method

protected send_session_pkt ( )

send_start_stream() protected method

protected send_start_stream ( XMPPJid $jid )
$jid XMPPJid

send_starttls_pkt() protected method

protected send_starttls_pkt ( )

setup() public method

public setup ( $event, $args )

wait_for_bind_response() public method

public wait_for_bind_response ( $event, $args )

wait_for_compression_result() public method

public wait_for_compression_result ( $event, $args )

wait_for_sasl_response() public method

public wait_for_sasl_response ( $event, $args )

wait_for_session_response() public method

public wait_for_session_response ( $event, $args )

wait_for_stream_features() public method

XEP-0170: Recommended Order of Stream Feature Negotiation
public wait_for_stream_features ( $event, $args )

wait_for_stream_start() public method

public wait_for_stream_start ( $event, $args )

wait_for_tls_result() public method

public wait_for_tls_result ( $event, $args )

Property Details

$force_tls public property

public $force_tls

$full_jid public property

jid with binding resource value
public $full_jid

$jid public property

public XMPPJid $jid
return XMPPJid

$last_id protected property

stanza id
protected $last_id

$pass public property

public $pass

$resource public property

public $resource

$trans protected property

Socket/BOSH reference.
protected JAXLClientBase $trans
return JAXLClientBase

$xml protected property

XML stream reference.
protected JAXLXmlStream $xml
return JAXLXmlStream