Skip to content

Commit

Permalink
Update Main.MD
Browse files Browse the repository at this point in the history
  • Loading branch information
bkeevil authored Oct 11, 2018
1 parent ab9508a commit 5c73c62
Showing 1 changed file with 1 addition and 24 deletions.
25 changes: 1 addition & 24 deletions doc/Main.MD
Original file line number Diff line number Diff line change
@@ -1,26 +1,4 @@
# Documentation Main Page

## General Client Useage

Place a TMQTTClient on your datamodule and follow the examples of the MQTT client application to implement the events that enable the component to send and receive data through a transport mechanism. In the demo apps, the transport mechanism is the lnet component set.

Set the properties for the client and your transport mechanism and test that it works.

For each subscription you wish to create, place a TMQTTClientSubscription component on the datamodule and set its properties. These subscriptions will be automatically sent to the server when needed.

Alternatively, you can implement the OnInitSession event handler, manually create a TMQTTSubscriptionList object at runtime, and call Subscribe() with this list.

For each message you wish to publish, you can either call the TMQTTClient.Publish() method directly or use TMQTTPublisher components provided.

## General Server Useage

Follow the examples in the demo applications.

There is currently no validation of usernames/passwords, your server must provide these using the component's event handlers.

## Documentation

There are older docs in the FPDocs format that are mixed in with the newer documentation in the docs directory. The newer documentation will be done in Markdown. I intend to delete the FPDocs stuff once this migration is complete.
# Documentation Index

Document | Description
:--- | :---
Expand All @@ -36,4 +14,3 @@ Document | Description
[TMQTTSubscription](TMQTTSubscription.MD) | Represents a subscription on the server
[MQTTPackets.pas](MQTTPackets.MD) | Defines MQTT packet base classes and utility classes. Used internally for parsing packets
[MQTTPacketDefs.pas](MQTTPacketDefs.MD) | Defines MQTT packet structure and validation constraints according to MQTT 3.1.1

0 comments on commit 5c73c62

Please sign in to comment.