Class: Mosquitto::Client
- Inherits:
-
Object
- Object
- Mosquitto::Client
- Includes:
- Logging
- Defined in:
- ext/mosquitto/client.c,
lib/mosquitto/client.rb
Constant Summary
Constants included from Logging
Class Method Summary collapse
-
.Mosquitto::Client.new("some-id") ⇒ Mosquitto::Client
Create a new mosquitto client instance.
Instance Method Summary collapse
-
#auth("username", "password") ⇒ Boolean
Configure username and password for a mosquitto instance.
-
#connect("localhost", 1883, 10) ⇒ Boolean
Connect to an MQTT broker.
-
#connect_async("localhost", 1883, 10) ⇒ Boolean
Connect to an MQTT broker.
-
#connect_bind("localhost", 1883, 10, "10.0.0.3") ⇒ Boolean
Connect to an MQTT broker.
-
#connect_bind_async("localhost", 1883, 10, "10.0.0.3") ⇒ Boolean
Connect to an MQTT broker.
-
#disconnect ⇒ true
Disconnect from the broker.
-
#loop(10, 10) ⇒ Boolean
The main network loop for the client.
-
#loop_forever(10, 1) ⇒ Boolean
This function calls Mosquitto::Client#loop for you in an infinite blocking loop.
-
#loop_misc ⇒ Boolean
Carry out miscellaneous operations required as part of the network loop.
-
#loop_read(10) ⇒ Boolean
Carry out network read operations.
-
#loop_start ⇒ Boolean
This is part of the threaded client interface.
-
#loop_start ⇒ Boolean
This is part of the threaded client interface.
-
#loop_write(1) ⇒ Boolean
Carry out network write operations.
-
#max_inflight_messages=(10) ⇒ Boolean
Set the number of QoS 1 and 2 messages that can be “in flight” at one time.
-
#message_retry=(10) ⇒ Boolean
Set the number of seconds to wait before retrying messages.
-
#on_connect {|rc| ... } ⇒ Boolean
Set the connect callback.
-
#on_disconnect {|rc| ... } ⇒ Boolean
Set the disconnect callback.
-
#on_log {|level, msg| ... } ⇒ Boolean
Set the logging callback.
-
#on_message {|msg| ... } ⇒ Boolean
Set the message callback.
-
#on_publish {|mid| ... } ⇒ Boolean
Set the publish callback.
-
#on_subscribe {|mid, granted_qos| ... } ⇒ Boolean
Set the subscribe callback.
-
#on_unsubscribe {|mid| ... } ⇒ Boolean
Set the unsubscribe callback.
-
#publish(3, "publish", "test", Mosquitto: :AT_MOST_ONCE, true) ⇒ Boolean
Publish a message on a given topic.
-
#reconnect ⇒ Boolean
Reconnect to a broker.
-
#reconnect_delay_set(2, 10, true) ⇒ Boolean
Control the behaviour of the client when it has unexpectedly disconnected in Mosquitto::Client#loop_forever or after Mosquitto::Client#loop_start.
-
#reinitialise("some-id") ⇒ Mosquitto::Client
Allows an existing mosquitto client to be reused.
-
#socket ⇒ Integer
Return the socket handle for a mosquitto instance.
-
#subscribe(3, "subscribe", Mosquitto: :AT_MOST_ONCE) ⇒ Boolean
Subscribe to a topic.
-
#insecure=(true) ⇒ Boolean
Configure verification of the server hostname in the server certificate.
-
#tls_opts_set(Mosquitto: :SSL_VERIFY_PEER, "tlsv1.2", nil) ⇒ Boolean
Set advanced SSL/TLS options.
-
#tls_psk_set("deadbeef", "psk-id", nil) ⇒ Boolean
Configure the client for pre-shared-key based TLS support.
-
#tls_set('/certs/all-ca.crt') ⇒ Boolean
Configure the client for certificate based SSL/TLS support.
-
#unsubscribe(3, "unsubscribe") ⇒ Boolean
Unsubscribe from a topic.
-
#want_write? ⇒ Boolean
Returns true if there is data ready to be written on the socket.
-
#will_clear ⇒ Boolean
Remove a previously configured will.
-
#will_set("topic", "died", Mosquitto: :AT_MOST_ONCE, false) ⇒ Mosquitto::Client
Configure will information for a mosquitto instance.
Methods included from Logging
Class Method Details
.Mosquitto::Client.new("some-id") ⇒ Mosquitto::Client
As per the MQTT spec, client identifiers cannot exceed 23 characters
Create a new mosquitto client instance.
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 |
# File 'ext/mosquitto/client.c', line 471
static VALUE rb_mosquitto_client_s_new(int argc, VALUE *argv, VALUE client)
{
VALUE client_id;
VALUE cl_session;
char *cl_id = NULL;
mosquitto_client_wrapper *cl = NULL;
bool clean_session;
rb_scan_args(argc, argv, "02", &client_id, &cl_session);
if (NIL_P(client_id)) {
clean_session = true;
} else {
clean_session = false;
Check_Type(client_id, T_STRING);
MosquittoEncode(client_id);
cl_id = StringValueCStr(client_id);
}
client = Data_Make_Struct(rb_cMosquittoClient, mosquitto_client_wrapper, rb_mosquitto_mark_client, rb_mosquitto_free_client, cl);
cl->mosq = mosquitto_new(cl_id, clean_session, (void *)cl);
if (cl->mosq == NULL) {
xfree(cl);
switch (errno) {
case EINVAL:
MosquittoError("invalid input params");
break;
case ENOMEM:
rb_memerror();
break;
default:
return Qfalse;
}
}
cl->connect_cb = Qnil;
cl->disconnect_cb = Qnil;
cl->publish_cb = Qnil;
cl->message_cb = Qnil;
cl->subscribe_cb = Qnil;
cl->unsubscribe_cb = Qnil;
cl->log_cb = Qnil;
cl->callback_thread = Qnil;
cl->callback_queue = NULL;
rb_obj_call_init(client, 0, NULL);
return client;
}
|
Instance Method Details
#auth("username", "password") ⇒ Boolean
This must be called before calling Mosquitto::Client#connect
Configure username and password for a mosquitto instance. This is only supported by brokers that implement the MQTT spec v3.1. By default, no username or password will be sent.
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 |
# File 'ext/mosquitto/client.c', line 664
static VALUE rb_mosquitto_client_auth(VALUE obj, VALUE username, VALUE password)
{
int ret;
MosquittoGetClient(obj);
if (!NIL_P(username)) {
Check_Type(username, T_STRING);
MosquittoEncode(username);
}
if (!NIL_P(password)) {
Check_Type(password, T_STRING);
MosquittoEncode(password);
}
ret = mosquitto_username_pw_set(client->mosq, (NIL_P(username) ? NULL : StringValueCStr(username)), (NIL_P(password) ? NULL : StringValueCStr(password)));
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NOMEM:
rb_memerror();
break;
default:
return Qtrue;
}
}
|
#connect("localhost", 1883, 10) ⇒ Boolean
Connect to an MQTT broker.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 |
# File 'ext/mosquitto/client.c', line 931
static VALUE rb_mosquitto_client_connect(VALUE obj, VALUE host, VALUE port, VALUE keepalive)
{
struct nogvl_connect_args args;
int ret;
MosquittoGetClient(obj);
Check_Type(host, T_STRING);
MosquittoEncode(host);
Check_Type(port, T_FIXNUM);
Check_Type(keepalive, T_FIXNUM);
args.mosq = client->mosq;
args.host = StringValueCStr(host);
args.port = NUM2INT(port);
args.keepalive = NUM2INT(keepalive);
ret = (int)rb_thread_call_without_gvl(rb_mosquitto_client_connect_nogvl, (void *)&args, RUBY_UBF_IO, 0);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_ERRNO:
rb_sys_fail("mosquitto_connect");
break;
default:
return Qtrue;
}
}
|
#connect_async("localhost", 1883, 10) ⇒ Boolean
Connect to an MQTT broker. This is a non-blocking call. If you use Mosquitto::Client#connect_async your client must use the threaded interface Mosquitto::Client#loop_start. If you need to use Mosquitto::Client#loop, you must use Mosquitto::Client#connect to connect the client.
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 |
# File 'ext/mosquitto/client.c', line 1035
static VALUE rb_mosquitto_client_connect_async(VALUE obj, VALUE host, VALUE port, VALUE keepalive)
{
struct nogvl_connect_args args;
int ret;
MosquittoGetClient(obj);
Check_Type(host, T_STRING);
MosquittoEncode(host);
Check_Type(port, T_FIXNUM);
Check_Type(keepalive, T_FIXNUM);
args.mosq = client->mosq;
args.host = StringValueCStr(host);
args.port = NUM2INT(port);
args.keepalive = NUM2INT(keepalive);
ret = (int)rb_thread_call_without_gvl(rb_mosquitto_client_connect_async_nogvl, (void *)&args, RUBY_UBF_IO, 0);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_ERRNO:
rb_sys_fail("mosquitto_connect_async");
break;
default:
return Qtrue;
}
}
|
#connect_bind("localhost", 1883, 10, "10.0.0.3") ⇒ Boolean
Connect to an MQTT broker. This extends the functionality of Mosquitto::Client#connect by adding the bind_address parameter. Use this function if you need to restrict network communication over a particular interface.
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 |
# File 'ext/mosquitto/client.c', line 981
static VALUE rb_mosquitto_client_connect_bind(VALUE obj, VALUE host, VALUE port, VALUE keepalive, VALUE bind_address)
{
struct nogvl_connect_args args;
int ret;
MosquittoGetClient(obj);
Check_Type(host, T_STRING);
MosquittoEncode(host);
Check_Type(port, T_FIXNUM);
Check_Type(keepalive, T_FIXNUM);
Check_Type(bind_address, T_STRING);
MosquittoEncode(bind_address);
args.mosq = client->mosq;
args.host = StringValueCStr(host);
args.port = NUM2INT(port);
args.keepalive = NUM2INT(keepalive);
args.bind_address = StringValueCStr(bind_address);
ret = (int)rb_thread_call_without_gvl(rb_mosquitto_client_connect_bind_nogvl, (void *)&args, RUBY_UBF_IO, 0);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_ERRNO:
rb_sys_fail("mosquitto_connect_bind");
break;
default:
return Qtrue;
}
}
|
#connect_bind_async("localhost", 1883, 10, "10.0.0.3") ⇒ Boolean
Connect to an MQTT broker. This is a non-blocking call. If you use Mosquitto::Client#connect_async your client must use the threaded interface Mosquitto::Client#loop_start. If you need to use Mosquitto::Client#loop, you must use Mosquitto::Client#connect to connect the client.
This extends the functionality of Mosquitto::Client#connect_async by adding the bind_address parameter. Use this function if you need to restrict network communication over a particular interface.
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 |
# File 'ext/mosquitto/client.c', line 1091
static VALUE rb_mosquitto_client_connect_bind_async(VALUE obj, VALUE host, VALUE port, VALUE keepalive, VALUE bind_address)
{
struct nogvl_connect_args args;
int ret;
MosquittoGetClient(obj);
Check_Type(host, T_STRING);
MosquittoEncode(host);
Check_Type(port, T_FIXNUM);
Check_Type(keepalive, T_FIXNUM);
Check_Type(bind_address, T_STRING);
MosquittoEncode(bind_address);
args.mosq = client->mosq;
args.host = StringValueCStr(host);
args.port = NUM2INT(port);
args.keepalive = NUM2INT(keepalive);
args.bind_address = StringValueCStr(bind_address);
ret = (int)rb_thread_call_without_gvl(rb_mosquitto_client_connect_bind_async_nogvl, (void *)&args, RUBY_UBF_IO, 0);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_ERRNO:
rb_sys_fail("mosquitto_connect_bind_async");
break;
default:
return Qtrue;
}
}
|
#disconnect ⇒ true
Disconnect from the broker.
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 |
# File 'ext/mosquitto/client.c', line 1175
static VALUE rb_mosquitto_client_disconnect(VALUE obj)
{
int ret;
MosquittoGetClient(obj);
ret = (int)rb_thread_call_without_gvl(rb_mosquitto_client_disconnect_nogvl, (void *)client->mosq, RUBY_UBF_IO, 0);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NO_CONN:
MosquittoError("client not connected to broker");
break;
default:
return Qtrue;
}
}
|
#loop(10, 10) ⇒ Boolean
The main network loop for the client. You must call this frequently in order to keep communications between the client and broker working. If incoming data is present it will then be processed. Outgoing commands, from e.g. Mosquitto::Client#publish, are normally sent immediately that their function is called, but this is not always possible. Mosquitto::Client#loop will also attempt to send any remaining outgoing messages, which also includes commands that are part of the flow for messages with QoS>0.
An alternative approach is to use Mosquitto::Client#loop_start to run the client loop in its own thread.
This calls select() to monitor the client network socket. If you want to integrate mosquitto client operation with your own select() call, use Mosquitto::Client#socket, Mosquitto::Client#loop_read, Mosquitto::Client#loop_write and Mosquitto::Client#loop_misc.
1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 |
# File 'ext/mosquitto/client.c', line 1425
static VALUE rb_mosquitto_client_loop(VALUE obj, VALUE timeout, VALUE max_packets)
{
struct nogvl_loop_args args;
int ret;
MosquittoGetClient(obj);
Check_Type(timeout, T_FIXNUM);
Check_Type(max_packets, T_FIXNUM);
args.mosq = client->mosq;
args.timeout = NUM2INT(timeout);
args.max_packets = NUM2INT(max_packets);
ret = (int)rb_thread_call_without_gvl(rb_mosquitto_client_loop_nogvl, (void *)&args, RUBY_UBF_IO, 0);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NOMEM:
rb_memerror();
break;
case MOSQ_ERR_NO_CONN:
MosquittoError("client not connected to broker");
break;
case MOSQ_ERR_CONN_LOST:
MosquittoError("connection to the broker was lost");
break;
case MOSQ_ERR_PROTOCOL:
MosquittoError("protocol error communicating with the broker");
break;
case MOSQ_ERR_ERRNO:
rb_sys_fail("mosquitto_loop");
break;
default:
return Qtrue;
}
}
|
#loop_forever(10, 1) ⇒ Boolean
This function calls Mosquitto::Client#loop for you in an infinite blocking loop. It is useful for the case where you only want to run the MQTT client loop in your program.
It handles reconnecting in case server connection is lost. If you call Mosquitto::Client#disconnect in a callback it will return.
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 |
# File 'ext/mosquitto/client.c', line 1492
static VALUE rb_mosquitto_client_loop_forever(VALUE obj, VALUE timeout, VALUE max_packets)
{
struct nogvl_loop_args args;
int ret;
MosquittoGetClient(obj);
Check_Type(timeout, T_FIXNUM);
Check_Type(max_packets, T_FIXNUM);
args.mosq = client->mosq;
args.timeout = NUM2INT(timeout);
args.max_packets = NUM2INT(max_packets);
ret = (int)rb_thread_call_without_gvl(rb_mosquitto_client_loop_forever_nogvl, (void *)&args, rb_mosquitto_client_loop_forever_ubf, client);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NOMEM:
rb_memerror();
break;
case MOSQ_ERR_NO_CONN:
MosquittoError("client not connected to broker");
break;
case MOSQ_ERR_CONN_LOST:
MosquittoError("connection to the broker was lost");
break;
case MOSQ_ERR_PROTOCOL:
MosquittoError("protocol error communicating with the broker");
break;
case MOSQ_ERR_ERRNO:
rb_sys_fail("mosquitto_loop");
break;
default:
return Qtrue;
}
}
|
#loop_misc ⇒ Boolean
Carry out miscellaneous operations required as part of the network loop. This should only be used if you are not using Mosquitto::Client#loop and are monitoring the client network socket for activity yourself.
This function deals with handling PINGs and checking whether messages need to be retried, so should be called fairly frequently.
1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 |
# File 'ext/mosquitto/client.c', line 1751
static VALUE rb_mosquitto_client_loop_misc(VALUE obj)
{
int ret;
MosquittoGetClient(obj);
ret = (int)rb_thread_call_without_gvl(rb_mosquitto_client_loop_misc_nogvl, (void *)client->mosq, RUBY_UBF_IO, 0);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NO_CONN:
MosquittoError("client not connected to broker");
break;
default:
return Qtrue;
}
}
|
#loop_read(10) ⇒ Boolean
Carry out network read operations. This should only be used if you are not using Mosquitto::Client#loop and are monitoring the client network socket for activity yourself.
1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 |
# File 'ext/mosquitto/client.c', line 1642
static VALUE rb_mosquitto_client_loop_read(VALUE obj, VALUE max_packets)
{
struct nogvl_loop_args args;
int ret;
MosquittoGetClient(obj);
Check_Type(max_packets, T_FIXNUM);
args.mosq = client->mosq;
args.max_packets = NUM2INT(max_packets);
ret = (int)rb_thread_call_without_gvl(rb_mosquitto_client_loop_read_nogvl, (void *)&args, RUBY_UBF_IO, 0);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NOMEM:
rb_memerror();
break;
case MOSQ_ERR_NO_CONN:
MosquittoError("client not connected to broker");
break;
case MOSQ_ERR_CONN_LOST:
MosquittoError("connection to the broker was lost");
break;
case MOSQ_ERR_PROTOCOL:
MosquittoError("protocol error communicating with the broker");
break;
case MOSQ_ERR_ERRNO:
rb_sys_fail("mosquitto_loop");
break;
default:
return Qtrue;
}
}
|
#loop_start ⇒ Boolean
This is part of the threaded client interface. Call this once to start a new thread to process network traffic. This provides an alternative to repeatedly calling Mosquitto::Client#loop yourself.
1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 |
# File 'ext/mosquitto/client.c', line 1546
static VALUE rb_mosquitto_client_loop_start(VALUE obj)
{
int ret;
struct timeval time;
MosquittoGetClient(obj);
/* Let's not spawn duplicate threaded loops */
if (!NIL_P(client->callback_thread)) return Qtrue;
ret = (int)rb_thread_call_without_gvl(rb_mosquitto_client_loop_start_nogvl, (void *)client->mosq, RUBY_UBF_IO, 0);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NOT_SUPPORTED :
MosquittoError("thread support is not available");
break;
default:
pthread_mutex_init(&client->callback_mutex, NULL);
pthread_cond_init(&client->callback_cond, NULL);
client->callback_thread = rb_thread_create(rb_mosquitto_callback_thread, client);
/* Allow the callback thread some startup time */
time.tv_sec = 0;
time.tv_usec = 100 * 1000; /* 0.1 sec */
rb_thread_wait_for(time);
return Qtrue;
}
}
|
#loop_start ⇒ Boolean
This is part of the threaded client interface. Call this once to stop the network thread previously created with Mosquitto::Client#loop_start. This call will block until the network thread finishes. For the network thread to end, you must have previously called Mosquitto::Client#disconnect or have set the force parameter to true.
1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 |
# File 'ext/mosquitto/client.c', line 1597
static VALUE rb_mosquitto_client_loop_stop(VALUE obj, VALUE force)
{
struct nogvl_loop_stop_args args;
int ret;
MosquittoGetClient(obj);
args.mosq = client->mosq;
args.force = ((force == Qtrue) ? true : false);
ret = (int)rb_thread_call_without_gvl(rb_mosquitto_client_loop_stop_nogvl, (void *)&args, RUBY_UBF_IO, 0);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NOT_SUPPORTED :
MosquittoError("thread support is not available");
break;
default:
pthread_mutex_destroy(&client->callback_mutex);
pthread_cond_destroy(&client->callback_cond);
rb_thread_kill(client->callback_thread);
client->callback_thread = Qnil;
return Qtrue;
}
}
|
#loop_write(1) ⇒ Boolean
Carry out network write operations. This should only be used if you are not using Mosquitto::Client#loop and are monitoring the client network socket for activity yourself.
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 |
# File 'ext/mosquitto/client.c', line 1696
static VALUE rb_mosquitto_client_loop_write(VALUE obj, VALUE max_packets)
{
struct nogvl_loop_args args;
int ret;
MosquittoGetClient(obj);
Check_Type(max_packets, T_FIXNUM);
args.mosq = client->mosq;
args.max_packets = NUM2INT(max_packets);
ret = (int)rb_thread_call_without_gvl(rb_mosquitto_client_loop_write_nogvl, (void *)&args, RUBY_UBF_IO, 0);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NOMEM:
rb_memerror();
break;
case MOSQ_ERR_NO_CONN:
MosquittoError("client not connected to broker");
break;
case MOSQ_ERR_CONN_LOST:
MosquittoError("connection to the broker was lost");
break;
case MOSQ_ERR_PROTOCOL:
MosquittoError("protocol error communicating with the broker");
break;
case MOSQ_ERR_ERRNO:
rb_sys_fail("mosquitto_loop");
break;
default:
return Qtrue;
}
}
|
#max_inflight_messages=(10) ⇒ Boolean
Set the number of QoS 1 and 2 messages that can be “in flight” at one time. An in flight message is part way through its delivery flow. Attempts to send further messages with mosquitto::Client#publish will result in the messages being queued until the number of in flight messages reduces.
A higher number here results in greater message throughput, but if set higher than the maximum in flight messages on the broker may lead to delays in the messages being acknowledged.
Set to 0 for no maximum.
1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 |
# File 'ext/mosquitto/client.c', line 1857
static VALUE rb_mosquitto_client_max_inflight_messages_equals(VALUE obj, VALUE max_messages)
{
int ret;
MosquittoGetClient(obj);
Check_Type(max_messages, T_FIXNUM);
ret = mosquitto_max_inflight_messages_set(client->mosq, INT2NUM(max_messages));
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
default:
return Qtrue;
}
}
|
#message_retry=(10) ⇒ Boolean
Set the number of seconds to wait before retrying messages. This applies to publish messages with QoS>0. May be called at any time.
1886 1887 1888 1889 1890 1891 1892 |
# File 'ext/mosquitto/client.c', line 1886
static VALUE rb_mosquitto_client_message_retry_equals(VALUE obj, VALUE seconds)
{
MosquittoGetClient(obj);
Check_Type(seconds, T_FIXNUM);
mosquitto_message_retry_set(client->mosq, INT2NUM(seconds));
return Qtrue;
}
|
#on_connect {|rc| ... } ⇒ Boolean
Set the connect callback. This is called when the broker sends a CONNACK message in response to a connection.
1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 |
# File 'ext/mosquitto/client.c', line 1912
static VALUE rb_mosquitto_client_on_connect(int argc, VALUE *argv, VALUE obj)
{
VALUE proc, cb;
MosquittoGetClient(obj);
rb_scan_args(argc, argv, "01&", &proc, &cb);
MosquittoAssertCallback(cb, 1);
if (!NIL_P(client->connect_cb)) rb_gc_unregister_address(&client->connect_cb);
mosquitto_connect_callback_set(client->mosq, rb_mosquitto_client_on_connect_cb);
client->connect_cb = cb;
rb_gc_register_address(&client->connect_cb);
return Qtrue;
}
|
#on_disconnect {|rc| ... } ⇒ Boolean
Set the disconnect callback. This is called when the broker has received the DISCONNECT command and has disconnected the client.
1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 |
# File 'ext/mosquitto/client.c', line 1942
static VALUE rb_mosquitto_client_on_disconnect(int argc, VALUE *argv, VALUE obj)
{
VALUE proc, cb;
MosquittoGetClient(obj);
rb_scan_args(argc, argv, "01&", &proc, &cb);
MosquittoAssertCallback(cb, 1);
if (!NIL_P(client->disconnect_cb)) rb_gc_unregister_address(&client->disconnect_cb);
mosquitto_disconnect_callback_set(client->mosq, rb_mosquitto_client_on_disconnect_cb);
client->disconnect_cb = cb;
rb_gc_register_address(&client->disconnect_cb);
return Qtrue;
}
|
#on_log {|level, msg| ... } ⇒ Boolean
Set the logging callback. This should be used if you want event logging information from the client library.
2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 |
# File 'ext/mosquitto/client.c', line 2087
static VALUE rb_mosquitto_client_on_log(int argc, VALUE *argv, VALUE obj)
{
VALUE proc, cb;
MosquittoGetClient(obj);
rb_scan_args(argc, argv, "01&", &proc, &cb);
MosquittoAssertCallback(cb, 2);
if (!NIL_P(client->log_cb)) rb_gc_unregister_address(&client->log_cb);
mosquitto_log_callback_set(client->mosq, rb_mosquitto_client_on_log_cb);
client->log_cb = cb;
rb_gc_register_address(&client->log_cb);
return Qtrue;
}
|
#on_message {|msg| ... } ⇒ Boolean
Set the message callback. This is called when a message is received from the broker.
1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 |
# File 'ext/mosquitto/client.c', line 1998
static VALUE rb_mosquitto_client_on_message(int argc, VALUE *argv, VALUE obj)
{
VALUE proc, cb;
MosquittoGetClient(obj);
rb_scan_args(argc, argv, "01&", &proc, &cb);
MosquittoAssertCallback(cb, 1);
if (!NIL_P(client->message_cb)) rb_gc_unregister_address(&client->message_cb);
mosquitto_message_callback_set(client->mosq, rb_mosquitto_client_on_message_cb);
client->message_cb = cb;
rb_gc_register_address(&client->message_cb);
return Qtrue;
}
|
#on_publish {|mid| ... } ⇒ Boolean
Set the publish callback. This is called when a message initiated with Mosquitto::Client#publish has been sent to the broker successfully.
1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 |
# File 'ext/mosquitto/client.c', line 1970
static VALUE rb_mosquitto_client_on_publish(int argc, VALUE *argv, VALUE obj)
{
VALUE proc, cb;
MosquittoGetClient(obj);
rb_scan_args(argc, argv, "01&", &proc, &cb);
MosquittoAssertCallback(cb, 1);
if (!NIL_P(client->publish_cb)) rb_gc_unregister_address(&client->publish_cb);
mosquitto_publish_callback_set(client->mosq, rb_mosquitto_client_on_publish_cb);
client->publish_cb = cb;
rb_gc_register_address(&client->publish_cb);
return Qtrue;
}
|
#on_subscribe {|mid, granted_qos| ... } ⇒ Boolean
Set the subscribe callback. This is called when the broker responds to a subscription request.
2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 |
# File 'ext/mosquitto/client.c', line 2028
static VALUE rb_mosquitto_client_on_subscribe(int argc, VALUE *argv, VALUE obj)
{
VALUE proc, cb;
MosquittoGetClient(obj);
rb_scan_args(argc, argv, "01&", &proc, &cb);
MosquittoAssertCallback(cb, 2);
if (!NIL_P(client->subscribe_cb)) rb_gc_unregister_address(&client->subscribe_cb);
mosquitto_subscribe_callback_set(client->mosq, rb_mosquitto_client_on_subscribe_cb);
client->subscribe_cb = cb;
rb_gc_register_address(&client->subscribe_cb);
return Qtrue;
}
|
#on_unsubscribe {|mid| ... } ⇒ Boolean
Set the unsubscribe callback. This is called when the broker responds to a unsubscription request.
2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 |
# File 'ext/mosquitto/client.c', line 2057
static VALUE rb_mosquitto_client_on_unsubscribe(int argc, VALUE *argv, VALUE obj)
{
VALUE proc, cb;
MosquittoGetClient(obj);
rb_scan_args(argc, argv, "01&", &proc, &cb);
MosquittoAssertCallback(cb, 1);
if (!NIL_P(client->unsubscribe_cb)) rb_gc_unregister_address(&client->unsubscribe_cb);
mosquitto_unsubscribe_callback_set(client->mosq, rb_mosquitto_client_on_unsubscribe_cb);
client->unsubscribe_cb = cb;
rb_gc_register_address(&client->unsubscribe_cb);
return Qtrue;
}
|
#publish(3, "publish", "test", Mosquitto: :AT_MOST_ONCE, true) ⇒ Boolean
Publish a message on a given topic.
1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 |
# File 'ext/mosquitto/client.c', line 1218
static VALUE rb_mosquitto_client_publish(VALUE obj, VALUE mid, VALUE topic, VALUE payload, VALUE qos, VALUE retain)
{
struct nogvl_publish_args args;
int ret, msg_id;
MosquittoGetClient(obj);
Check_Type(topic, T_STRING);
MosquittoEncode(topic);
Check_Type(payload, T_STRING);
MosquittoEncode(payload);
Check_Type(qos, T_FIXNUM);
if (!NIL_P(mid)) {
Check_Type(mid, T_FIXNUM);
msg_id = NUM2INT(mid);
}
args.mosq = client->mosq;
args.mid = NIL_P(mid) ? NULL : &msg_id;
args.topic = StringValueCStr(topic);
args.payloadlen = (int)RSTRING_LEN(payload);
args.payload = (const char *)(args.payloadlen == 0 ? NULL : StringValueCStr(payload));
args.qos = NUM2INT(qos);
args.retain = (retain == Qtrue) ? true : false;
ret = (int)rb_thread_call_without_gvl(rb_mosquitto_client_publish_nogvl, (void *)&args, RUBY_UBF_IO, 0);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NOMEM:
rb_memerror();
break;
case MOSQ_ERR_NO_CONN:
MosquittoError("client not connected to broker");
break;
case MOSQ_ERR_PROTOCOL:
MosquittoError("protocol error communicating with broker");
break;
case MOSQ_ERR_PAYLOAD_SIZE:
MosquittoError("payload too large");
break;
default:
return Qtrue;
}
}
|
#reconnect ⇒ Boolean
It must not be called before Mosquitto::Client#connect
Reconnect to a broker.
This function provides an easy way of reconnecting to a broker after a connection has been lost. It uses the values that were provided in the Mosquitto::Client#connect call.
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 |
# File 'ext/mosquitto/client.c', line 1141
static VALUE rb_mosquitto_client_reconnect(VALUE obj)
{
int ret;
MosquittoGetClient(obj);
ret = (int)rb_thread_call_without_gvl(rb_mosquitto_client_reconnect_nogvl, (void *)client->mosq, RUBY_UBF_IO, 0);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_ERRNO:
rb_sys_fail("mosquitto_reconnect");
break;
default:
return Qtrue;
}
}
|
#reconnect_delay_set(2, 10, true) ⇒ Boolean
Control the behaviour of the client when it has unexpectedly disconnected in Mosquitto::Client#loop_forever or after Mosquitto::Client#loop_start. The default behaviour if this function is not used is to repeatedly attempt to reconnect with a delay of 1 second until the connection succeeds.
Use reconnect_delay parameter to change the delay between successive reconnection attempts. You may also enable exponential backoff of the time between reconnections by setting reconnect_exponential_backoff to true and set an upper bound on the delay with reconnect_delay_max.
Example 1: delay=2, delay_max=10, exponential_backoff=False Delays would be: 2, 4, 6, 8, 10, 10, …
Example 2: delay=3, delay_max=30, exponential_backoff=True Delays would be: 3, 6, 12, 24, 30, 30, …
1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 |
# File 'ext/mosquitto/client.c', line 1819
static VALUE rb_mosquitto_client_reconnect_delay_set(VALUE obj, VALUE delay, VALUE delay_max, VALUE exp_backoff)
{
int ret;
MosquittoGetClient(obj);
Check_Type(delay, T_FIXNUM);
Check_Type(delay_max, T_FIXNUM);
ret = mosquitto_reconnect_delay_set(client->mosq, INT2NUM(delay), INT2NUM(delay_max), ((exp_backoff == Qtrue) ? true : false));
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
default:
return Qtrue;
}
}
|
#reinitialise("some-id") ⇒ Mosquitto::Client
As per the MQTT spec, client identifiers cannot exceed 23 characters
Allows an existing mosquitto client to be reused. Call on a mosquitto instance to close any open network connections, free memory and reinitialise the client with the new parameters.
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 |
# File 'ext/mosquitto/client.c', line 541
static VALUE rb_mosquitto_client_reinitialise(int argc, VALUE *argv, VALUE obj)
{
struct nogvl_reinitialise_args args;
VALUE client_id;
int ret;
bool clean_session;
char *cl_id = NULL;
MosquittoGetClient(obj);
rb_scan_args(argc, argv, "01", &client_id);
if (NIL_P(client_id)) {
clean_session = true;
} else {
clean_session = false;
Check_Type(client_id, T_STRING);
MosquittoEncode(client_id);
cl_id = StringValueCStr(client_id);
}
args.mosq = client->mosq;
args.client_id = cl_id;
args.clean_session = clean_session;
args.obj = (void *)obj;
ret = (int)rb_thread_call_without_gvl(rb_mosquitto_client_reinitialise_nogvl, (void *)&args, RUBY_UBF_IO, 0);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NOMEM:
rb_memerror();
break;
default:
return Qtrue;
}
}
|
#socket ⇒ Integer
Return the socket handle for a mosquitto instance. Useful if you want to include a mosquitto client in your own select() calls.
1381 1382 1383 1384 1385 1386 1387 |
# File 'ext/mosquitto/client.c', line 1381
static VALUE rb_mosquitto_client_socket(VALUE obj)
{
int socket;
MosquittoGetClient(obj);
socket = mosquitto_socket(client->mosq);
return INT2NUM(socket);
}
|
#subscribe(3, "subscribe", Mosquitto: :AT_MOST_ONCE) ⇒ Boolean
Subscribe to a topic.
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 |
# File 'ext/mosquitto/client.c', line 1285
static VALUE rb_mosquitto_client_subscribe(VALUE obj, VALUE mid, VALUE subscription, VALUE qos)
{
struct nogvl_subscribe_args args;
int ret, msg_id;
MosquittoGetClient(obj);
Check_Type(subscription, T_STRING);
MosquittoEncode(subscription);
Check_Type(qos, T_FIXNUM);
if (!NIL_P(mid)) {
Check_Type(mid, T_FIXNUM);
msg_id = NUM2INT(mid);
}
args.mosq = client->mosq;
args.mid = NIL_P(mid) ? NULL : &msg_id;
args.subscription = StringValueCStr(subscription);
args.qos = NUM2INT(qos);
ret = (int)rb_thread_call_without_gvl(rb_mosquitto_client_subscribe_nogvl, (void *)&args, RUBY_UBF_IO, 0);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NOMEM:
rb_memerror();
break;
case MOSQ_ERR_NO_CONN:
MosquittoError("client not connected to broker");
break;
default:
return Qtrue;
}
}
|
#insecure=(true) ⇒ Boolean
This must be called before calling Mosquitto::Client#connect
Configure verification of the server hostname in the server certificate. If value is set to true, it is impossible to guarantee that the host you are connecting to is not impersonating your server. This can be useful in initial server testing, but makes it possible for a malicious third party to impersonate your server through DNS spoofing, for example. Do not use this function in a real system. Setting value to true makes the connection encryption pointless.
790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 |
# File 'ext/mosquitto/client.c', line 790
static VALUE rb_mosquitto_client_tls_insecure_set(VALUE obj, VALUE insecure)
{
int ret;
MosquittoGetClient(obj);
if (insecure != Qtrue && insecure != Qfalse) {
rb_raise(rb_eTypeError, "changing TLS verification semantics requires a boolean value");
}
ret = mosquitto_tls_insecure_set(client->mosq, ((insecure == Qtrue) ? true : false));
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NOT_SUPPORTED:
MosquittoError("TLS support is not available");
default:
return Qtrue;
}
}
|
#tls_opts_set(Mosquitto: :SSL_VERIFY_PEER, "tlsv1.2", nil) ⇒ Boolean
This must be called before calling Mosquitto::Client#connect
Set advanced SSL/TLS options.
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 |
# File 'ext/mosquitto/client.c', line 831
static VALUE rb_mosquitto_client_tls_opts_set(VALUE obj, VALUE cert_reqs, VALUE tls_version, VALUE ciphers)
{
int ret;
MosquittoGetClient(obj);
Check_Type(cert_reqs, T_FIXNUM);
if (!NIL_P(tls_version)) {
Check_Type(tls_version, T_STRING);
MosquittoEncode(tls_version);
}
if (!NIL_P(ciphers)) {
Check_Type(ciphers, T_STRING);
MosquittoEncode(ciphers);
}
if (NUM2INT(cert_reqs) != 0 && NUM2INT(cert_reqs) != 1) {
MosquittoError("TLS verification requirement should be one of Mosquitto::SSL_VERIFY_NONE or Mosquitto::SSL_VERIFY_PEER");
}
ret = mosquitto_tls_opts_set(client->mosq, NUM2INT(cert_reqs), (NIL_P(tls_version) ? NULL : StringValueCStr(tls_version)), (NIL_P(ciphers) ? NULL : StringValueCStr(ciphers)));
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NOMEM:
rb_memerror();
break;
case MOSQ_ERR_NOT_SUPPORTED:
MosquittoError("TLS support is not available");
default:
return Qtrue;
}
}
|
#tls_psk_set("deadbeef", "psk-id", nil) ⇒ Boolean
This must be called before calling Mosquitto::Client#connect
Configure the client for pre-shared-key based TLS support.
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 |
# File 'ext/mosquitto/client.c', line 883
static VALUE rb_mosquitto_client_tls_psk_set(VALUE obj, VALUE psk, VALUE identity, VALUE ciphers)
{
int ret;
MosquittoGetClient(obj);
Check_Type(psk, T_STRING);
Check_Type(identity, T_STRING);
if (!NIL_P(ciphers)) {
Check_Type(ciphers, T_STRING);
MosquittoEncode(ciphers);
}
ret = mosquitto_tls_psk_set(client->mosq, StringValueCStr(psk), StringValueCStr(identity), (NIL_P(ciphers) ? NULL : StringValueCStr(ciphers)));
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NOMEM:
rb_memerror();
break;
case MOSQ_ERR_NOT_SUPPORTED:
MosquittoError("TLS support is not available");
default:
return Qtrue;
}
}
|
#tls_set('/certs/all-ca.crt') ⇒ Boolean
This must be called before calling Mosquitto::Client#connect
Configure the client for certificate based SSL/TLS support.
Cannot be used in conjunction with Mosquitto::Client#tls_psk_set.
Define the Certificate Authority certificates to be trusted (ie. the server certificate must be signed with one of these certificates) using cafile.
If the server you are connecting to requires clients to provide a certificate, define certfile and keyfile with your client certificate and private key
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 |
# File 'ext/mosquitto/client.c', line 720
static VALUE rb_mosquitto_client_tls_set(VALUE obj, VALUE cafile, VALUE capath, VALUE certfile, VALUE keyfile, VALUE password)
{
int ret;
int (*pw_callback)(char *, int, int, void *) = NULL;
MosquittoGetClient(obj);
if (!NIL_P(cafile)) {
Check_Type(cafile, T_STRING);
MosquittoEncode(cafile);
}
if (!NIL_P(capath)) {
Check_Type(capath, T_STRING);
MosquittoEncode(capath);
}
if (!NIL_P(certfile)) {
Check_Type(certfile, T_STRING);
MosquittoEncode(certfile);
}
if (!NIL_P(keyfile)) {
Check_Type(keyfile, T_STRING);
MosquittoEncode(keyfile);
}
if (!NIL_P(password)) {
Check_Type(password, T_STRING);
mosquitto_tls_password = password;
rb_gc_register_address(&mosquitto_tls_password);
pw_callback = rb_mosquitto_tls_password_callback;
}
if (NIL_P(cafile) && NIL_P(capath)) MosquittoError("Either CA path or CA file is required!");
if (NIL_P(certfile) && !NIL_P(keyfile)) MosquittoError("Key file can only be used with a certificate file!");
if (NIL_P(keyfile) && !NIL_P(certfile)) MosquittoError("Certificate file also requires a key file!");
ret = mosquitto_tls_set(client->mosq, (NIL_P(cafile) ? NULL : StringValueCStr(cafile)), (NIL_P(capath) ? NULL : StringValueCStr(capath)), (NIL_P(certfile) ? NULL : StringValueCStr(certfile)), (NIL_P(keyfile) ? NULL : StringValueCStr(keyfile)), pw_callback);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NOMEM:
rb_memerror();
break;
case MOSQ_ERR_NOT_SUPPORTED:
MosquittoError("TLS support is not available");
default:
return Qtrue;
}
}
|
#unsubscribe(3, "unsubscribe") ⇒ Boolean
Unsubscribe from a topic.
1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 |
# File 'ext/mosquitto/client.c', line 1339
static VALUE rb_mosquitto_client_unsubscribe(VALUE obj, VALUE mid, VALUE subscription)
{
struct nogvl_subscribe_args args;
int ret, msg_id;
MosquittoGetClient(obj);
Check_Type(subscription, T_STRING);
MosquittoEncode(subscription);
if (!NIL_P(mid)) {
Check_Type(mid, T_FIXNUM);
msg_id = NUM2INT(mid);
}
args.mosq = client->mosq;
args.mid = NIL_P(mid) ? NULL : &msg_id;
args.subscription = StringValueCStr(subscription);
ret = (int)rb_thread_call_without_gvl(rb_mosquitto_client_unsubscribe_nogvl, (void *)&args, RUBY_UBF_IO, 0);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NOMEM:
rb_memerror();
break;
case MOSQ_ERR_NO_CONN:
MosquittoError("client not connected to broker");
break;
default:
return Qtrue;
}
}
|
#want_write? ⇒ Boolean
Returns true if there is data ready to be written on the socket.
1779 1780 1781 1782 1783 1784 1785 |
# File 'ext/mosquitto/client.c', line 1779
static VALUE rb_mosquitto_client_want_write(VALUE obj)
{
bool ret;
MosquittoGetClient(obj);
ret = mosquitto_want_write(client->mosq);
return (ret == true) ? Qtrue : Qfalse;
}
|
#will_clear ⇒ Boolean
This must be called before calling Mosquitto::Client#connect
Remove a previously configured will.
633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'ext/mosquitto/client.c', line 633
static VALUE rb_mosquitto_client_will_clear(VALUE obj)
{
int ret;
MosquittoGetClient(obj);
ret = mosquitto_will_clear(client->mosq);
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
default:
return Qtrue;
}
}
|
#will_set("topic", "died", Mosquitto: :AT_MOST_ONCE, false) ⇒ Mosquitto::Client
This must be called before calling Mosquitto::Client#connect
Configure will information for a mosquitto instance. By default, clients do not have a will.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 |
# File 'ext/mosquitto/client.c', line 593
static VALUE rb_mosquitto_client_will_set(VALUE obj, VALUE topic, VALUE payload, VALUE qos, VALUE retain)
{
int ret;
int payload_len;
MosquittoGetClient(obj);
Check_Type(topic, T_STRING);
MosquittoEncode(topic);
Check_Type(payload, T_STRING);
MosquittoEncode(payload);
Check_Type(qos, T_FIXNUM);
payload_len = (int)RSTRING_LEN(payload);
ret = mosquitto_will_set(client->mosq, StringValueCStr(topic), payload_len, (payload_len == 0 ? NULL : StringValueCStr(payload)), NUM2INT(qos), ((retain == Qtrue) ? true : false));
switch (ret) {
case MOSQ_ERR_INVAL:
MosquittoError("invalid input params");
break;
case MOSQ_ERR_NOMEM:
rb_memerror();
break;
case MOSQ_ERR_PAYLOAD_SIZE:
MosquittoError("payload too large");
break;
default:
return Qtrue;
}
}
|