Class HttpClient
MDNSClass Class
Description
A class used for registering and removing MDNS service records.
Members
Public Constructors |
|
|---|
The public constructor should not be used as this class is
intended to be a singleton class. Access member functions using
the object instance named MDNS. |
|
Public Methods |
|
|---|
MDNSClass::begin |
Start MDNS operations |
MDNSClass::end |
Stop MDNS operations |
MDNSClass::registerService |
Add a service record |
MDNSClass::deregisterService |
Remove service record |
MDNSClass::updateService |
Update service record |
MDNSClass::begin
Description
Start MDNS operations to begin responding to MDNS queries.
Parameters
The function requires no input parameter.
Returns
The function returns nothing.
Example Code
Example: mDNS_On_Arduino_IDE
This example shows how to register Ameba as a service that can be
recognized by Arduino IDE. If both of the PC runs Arduino IDE and the
Ameba board are connecting to the same local network. Then you can
find Ameba in “Tools” -> “Port” -> “Arduino at 192.168.1.238 (Ameba
RTL8195A), which means the Arduino IDE find Ameba via mDNS.
#include <WiFi.h>
#include <AmebaMDNS.h>
char ssid[] = “yourNetwork”; // your network SSID (name)
char pass[] = “secretPassword”; // your network password
MDNSService service(“MyAmeba”, “_arduino._tcp”, “local”, 5000);
void setup() {
printf(“Try to connect to %srn”, ssid);
while (WiFi.begin(ssid, pass) != WL_CONNECTED) {
printf(“Failed. Wait 1s and retry…rn”);
delay(1000);
}
printf(“Connected to %srn”, ssid);
service.addTxtRecord(“board”, strlen(“ameba_rtl8195a”),
“ameba_rtl8195a”);
service.addTxtRecord(“auth_upload”, strlen(“no”), “no”);
service.addTxtRecord(“tcp_check”, strlen(“no”), “no”);
service.addTxtRecord(“ssh_upload”, strlen(“no”), “no”);
printf(“Start mDNS servicern”);
MDNS.begin();
printf(“register mDNS servicern”);
MDNS.registerService(service);
}
void loop() {
// put your main code here, to run repeatedly:
delay(1000);
}
Notes and Warnings
Include “AmebaMDNS.h” to use the class function.
MDNSClass::end
Description
Stop MDNS operations and stop responding to MDNS queries.
Parameters
The function requires no input parameter.
Returns
The function returns nothing.
Notes and Warnings
Include “AmebaMDNS.h” to use the class function.
MDNSClass::registerService
Description
Add a service record to be included in MDNS responses.
Syntax
void register service(MDNSService service);
Parameters
service: MDNSService class object with required MDNS service data
Returns
The function returns nothing.
Example Code
Example: mDNS_On_Arduino_IDE
Details of the code can be found in the previous section of
MDNSClass:: begin.
Notes and Warnings
Include “AmebaMDNS.h” to use the class function.
MDNSClass::deregisterService
Description
Remove a service record from MDNS responses.
Syntax
void deregisterService(MDNSService service);
Parameters
service: MDNSService class object to be removed
Returns
The function returns nothing.
Example Code
Example: mDNS_On_Arduino_IDE
Details of the code can be found in the previous section of
MDNSClass:: begin.
Notes and Warnings
Include “AmebaMDNS.h” to use the class function.
MDNSClass::updateService
Description
Update a service record.
Syntax
void updateService(MDNSService service, unsigned int ttl);
Parameters
service: MDNSService class object to be updated
ttl: time-to-live(TTL) for service
Returns
The function returns nothing.
Notes and Warnings
Include “AmebaMDNS.h” to use the class function.