From e67773869b55d1782c0b3059d66f51b2e9bfc9af Mon Sep 17 00:00:00 2001 From: Nicholas Shindler Date: Wed, 29 May 2024 00:00:21 +0200 Subject: [PATCH] update docs --- docs/src/api/client.md | 1 + docs/src/utils.md | 1 + ext/PrecompileMQTT.jl | 34 ---------------------------------- src/MQTTClient.jl | 1 + 4 files changed, 3 insertions(+), 34 deletions(-) diff --git a/docs/src/api/client.md b/docs/src/api/client.md index 9c549c2..cbf8ec9 100644 --- a/docs/src/api/client.md +++ b/docs/src/api/client.md @@ -4,4 +4,5 @@ Connection IOConnection MQTTClient.Message User +Configuration ``` \ No newline at end of file diff --git a/docs/src/utils.md b/docs/src/utils.md index fe39ef5..be97eef 100644 --- a/docs/src/utils.md +++ b/docs/src/utils.md @@ -1,4 +1,5 @@ ```@docs MQTTClient.resolve MQTTClient.topic_eq +MQTTClient.MockMQTTBroker ``` \ No newline at end of file diff --git a/ext/PrecompileMQTT.jl b/ext/PrecompileMQTT.jl index 8c0404e..35c12aa 100644 --- a/ext/PrecompileMQTT.jl +++ b/ext/PrecompileMQTT.jl @@ -8,40 +8,6 @@ using Sockets using MQTTClient -# precompile(Tuple{typeof(Core.kwcall), NamedTuple{(:qos,), Tuple{MQTTClient.QOS}}, typeof(MQTTClient.subscribe), MQTTClient.Client, String, Function}) -# precompile(Tuple{typeof(Core.kwcall), NamedTuple{(:qos,), Tuple{MQTTClient.QOS}}, typeof(MQTTClient.publish), MQTTClient.Client, String, String}) - -# precompile(Tuple{typeof(Base.convert), Type{MQTTClient.Packet}, MQTTClient.Packet}) -# precompile(Tuple{typeof(Base.write), Base.PipeEndpoint, Array{UInt8, 1}}) -# precompile(Tuple{typeof(Base.read), Base.PipeEndpoint, Type{UInt8}}) -# precompile(Tuple{typeof(Base.indexed_iterate), Tuple{Nothing, Int64}, Int64}) -# precompile(Tuple{typeof(Base.read), Base.PipeEndpoint, Int64}) -# precompile(Tuple{typeof(Base.haskey), Base.Dict{UInt8, Function}, UInt8}) -# precompile(Tuple{typeof(Base.getindex), Base.Dict{UInt8, Function}, UInt8}) -# precompile(Tuple{typeof(Base.indexed_iterate), Tuple{Nothing, Int64}, Int64, Int64}) -# precompile(Tuple{typeof(Base.read), Sockets.TCPSocket, Int64}) -# precompile(Tuple{typeof(Base.write), Base.PipeEndpoint, UInt8}) -# precompile(Tuple{typeof(Base.fetch), Base.Channel{Any}}) -# precompile(Tuple{typeof(Base.iterate), UInt16}) -# precompile(Tuple{typeof(Base.something), MQTTClient.TrieNode{MQTTClient.FunctionCallback}, Nothing, Vararg{Any}}) - -# precompile(Tuple{typeof(Sockets.connect), MQTTClient.Client, MQTTClient.Connection{MQTTClient.TCP}}) -# precompile(Tuple{typeof(Sockets.connect), Sockets.IPv6, Int64}) -# precompile(Tuple{typeof(Sockets.connect), MQTTClient.Client, MQTTClient.Connection{MQTTClient.UDS}}) -# precompile(Tuple{typeof(Sockets.connect), String}) - -# precompile(Tuple{typeof(MQTTClient.write_len), Sockets.TCPSocket, Int64}) -# precompile(Tuple{typeof(MQTTClient.read_len), Sockets.TCPSocket}) -# precompile(Tuple{typeof(MQTTClient.write_packet), MQTTClient.Client, UInt8, String, Vararg{Any}}) -# precompile(Tuple{typeof(MQTTClient.mqtt_write), Base.GenericIOBuffer{Array{UInt8, 1}}, UInt8}) -# precompile(Tuple{typeof(MQTTClient.write_len), Base.PipeEndpoint, Int64}) -# precompile(Tuple{typeof(MQTTClient.read_len), Base.PipeEndpoint}) -# precompile(Tuple{typeof(MQTTClient.mqtt_write), Base.GenericIOBuffer{Array{UInt8, 1}}, MQTTClient.QOS}) - -# precompile(Tuple{Type{MQTTClient.Packet}, UInt8, Tuple{}}) -# precompile(Tuple{Type{NamedTuple{(:qos,), T} where T<:Tuple}, Tuple{MQTTClient.QOS}}) - - # Precompiling the package like this provides a slower initial load of the package but faster code execution. # based on tests this precompile step reduces compilation at runtime by ~25% and decreases first execution time by ~10%. @setup_workload begin diff --git a/src/MQTTClient.jl b/src/MQTTClient.jl index 48d1fc4..ab1b382 100644 --- a/src/MQTTClient.jl +++ b/src/MQTTClient.jl @@ -19,6 +19,7 @@ include("interface.jl") export MakeConnection, + Configuration, Client, Connection, IOConnection,