Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
NickMcSweeney committed May 28, 2024
1 parent f75dda8 commit e677738
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 34 deletions.
1 change: 1 addition & 0 deletions docs/src/api/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ Connection
IOConnection
MQTTClient.Message
User
Configuration
```
1 change: 1 addition & 0 deletions docs/src/utils.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
```@docs
MQTTClient.resolve
MQTTClient.topic_eq
MQTTClient.MockMQTTBroker
```
34 changes: 0 additions & 34 deletions ext/PrecompileMQTT.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions src/MQTTClient.jl
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ include("interface.jl")

export
MakeConnection,
Configuration,
Client,
Connection,
IOConnection,
Expand Down

0 comments on commit e677738

Please sign in to comment.