Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Net::MQTT::Message::CoUsertContributed Perl DocuNet::MQTT::Message::Connect(3)

NAME
       Net::MQTT::Message::Connect - Perl module to represent an MQTT Connect
       message

VERSION
       version 1.143260

SYNOPSIS
	 # instantiated	by Net::MQTT::Message

DESCRIPTION
       This module encapsulates	a single MQTT Connection Request message.  It
       is a specific subclass used by Net::MQTT::Message and should not	need
       to be instantiated directly.

METHODS
   "protocol_name()"
       Returns the protocol name field of the MQTT Connect message.  The
       default is '"MQIsdp"'.

   "protocol_version()"
       Returns the protocol version field of the MQTT Connect message.	The
       default is 3.

   "user_name_flag()"
       Returns the user	name flag field	of the MQTT Connect message.  The
       default is true if and only if a	user name is defined.

   "password_flag()"
       Returns the password flag field of the MQTT Connect message.  The
       default is true if and only if a	password is defined.

   "will_retain()"
       Returns the will	retain field of	the MQTT Connect message.  The default
       is 0.

   "will_qos()"
       Returns the will	QoS field of the MQTT Connect message.	The default is
       0.

   "will_flag()"
       Returns the will	flag field of the MQTT Connect message.	 The default
       is true if and only if a	will topic is defined.

   "clean_session()"
       Returns the clean session flag field of the MQTT	Connect	message.  The
       default is 1.

   "connect_reserved_flag()"
       Returns the reserved flag field of the MQTT Connect message.  The
       default is 0.

   "keep_alive_timer()"
       Returns the keep	alive timer field of the MQTT Connect message.	The
       units are seconds.  The default is 60.

   "client_id()"
       Returns the client identifier field of the MQTT Connect message.	 The
       default is '"NetMQTTpm$$]"' where '$$' is the current process id.

   "will_topic()"
       Returns the will	topic field of the MQTT	Connect	message.  The default
       is undefined.

   "will_message()"
       Returns the will	message	field of the MQTT Connect message.  The
       default is undefined.

   "user_name()"
       Returns the user	name field of the MQTT Connect message.	 The default
       is undefined.

   "password()"
       Returns the password field of the MQTT Connect message.	The default is
       undefined.

AUTHOR
       Mark Hindess <soft-cpan@temporalanomaly.com>

COPYRIGHT AND LICENSE
       This software is	copyright (c) 2014 by Mark Hindess.

       This is free software; you can redistribute it and/or modify it under
       the same	terms as the Perl 5 programming	language system	itself.

perl v5.32.0			  2014-11-22	Net::MQTT::Message::Connect(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | METHODS | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Net::MQTT::Message::Connect&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help