Deprecated: Server¶
The classes described here are deprecated and kept for backward compatibility with WiFiNINA only. You should use WiFiSocket class instead.
Server Class¶
Server()¶
Description¶
Server is the base class for all WiFi server based calls. It is not called directly, but invoked whenever you use a function that relies on it.
WiFiServer()¶
Description¶
Creates a server that listens for incoming connections on the specified port.
Syntax¶
WiFiServer server(port);
Parameters¶
port: the port to listen on (int)
Returns¶
None
Example¶
#include <SPI.h>
#include <BetterWiFiNINA.h>
char ssid[] = "myNetwork"; // your network SSID (name)
char pass[] = "myPassword"; // your network password
int status = WL_IDLE_STATUS;
WiFiServer server(80);
void setup() {
// initialize serial:
Serial.begin(9600);
Serial.println("Attempting to connect to WPA network...");
Serial.print("SSID: ");
Serial.println(ssid);
status = WiFi.begin(ssid, pass);
if ( status != WL_CONNECTED) {
Serial.println("Couldn't get a WiFi connection");
while(true);
}
else {
server.begin();
Serial.print("Connected to WiFi. My address:");
IPAddress myAddress = WiFi.localIP();
Serial.println(myAddress);
}
}
void loop() {
}
server.begin()¶
Description¶
Tells the server to begin listening for incoming connections.
Syntax¶
server.begin()
Parameters¶
None
Returns¶
None
Example¶
#include <SPI.h>
#include <BetterWiFiNINA.h>
char ssid[] = "lamaison"; // your network SSID (name)
char pass[] = "tenantaccess247"; // your network password
int status = WL_IDLE_STATUS;
WiFiServer server(80);
void setup() {
// initialize serial:
Serial.begin(9600);
Serial.println("Attempting to connect to WPA network...");
Serial.print("SSID: ");
Serial.println(ssid);
status = WiFi.begin(ssid, pass);
if ( status != WL_CONNECTED) {
Serial.println("Couldn't get a WiFi connection");
while(true);
}
else {
server.begin();
Serial.print("Connected to WiFi. My address:");
IPAddress myAddress = WiFi.localIP();
Serial.println(myAddress);
}
}
void loop() {
}
if(server)¶
Description¶
Indicates whether the server is listening for new clients. You can use this to detect whether server.begin() was successful.
Syntax¶
if (server)
if (!server)
Parameters¶
none
Returns¶
whether the server is listening for new clients (bool).
Example¶
#include <WiFiNINA.h>
char ssid[] = "Network"; // your network SSID (name)
char pass[] = "myPassword"; // your network password
WiFiServer server(23);
void setup() {
Serial.begin(115200);
while (!Serial) {}
int status = WiFi.begin(ssid, pass);
if ( status != WL_CONNECTED) {
Serial.println("Couldn't get a WiFi connection");
while(true);
}
server.begin();
if (!server) {
Serial.println("Server failed to start.");
while(true);
}
}
void loop() {
WiFiClient client = server.available();
if (client) {
String s = client.readStringUntil('\n');
server.println(s);
}
}
server.status()¶
Description¶
Return Connection status.
Syntax¶
server.status()
Parameters¶
None
Returns¶
The server connection status
Example¶
…
Serial.print("connection status: ");
Serial.println(client.status());
…
server.write()¶
Description¶
Write data to all the clients connected to a server.
Syntax¶
server.write(data)
server.write(buffer, size);
Parameters¶
data: the outgoing byte
buffer: the outgoing message
size: the size of the buffer
Returns¶
The number of bytes written. It is not necessary to read this.
Example¶
#include <SPI.h>
#include <BetterWiFiNINA.h>
char ssid[] = "yourNetwork";
char pass[] = "yourPassword";
int status = WL_IDLE_STATUS;
WiFiServer server(80);
void setup() {
// initialize serial:
Serial.begin(9600);
Serial.println("Attempting to connect to WPA network...");
Serial.print("SSID: ");
Serial.println(ssid);
status = WiFi.begin(ssid, pass);
if ( status != WL_CONNECTED) {
Serial.println("Couldn't get a WiFi connection");
while(true);
}
else {
server.begin();
}
}
void loop() {
// listen for incoming clients
WiFiClient client = server.available();
if (client == true) {
// read bytes from the incoming client and write them back
// to any clients connected to the server:
server.write(client.read());
}
}
server.print()¶
Description¶
Print data to all the clients connected to a server. Prints numbers as a sequence of digits, each an ASCII character (e.g. the number 123 is sent as the three characters ‘1’, ‘2’, ‘3’).
Syntax¶
server.print(data)
server.print(data, BASE)
Parameters¶
data: the data to print (char, byte, int, long, or string)
BASE (optional): the base in which to print numbers: BIN for binary (base 2), DEC for decimal (base 10), OCT for octal (base 8), HEX for hexadecimal (base 16).
Returns¶
byte
print() will return the number of bytes written, though reading that number is optional
server.println()¶
Description¶
Prints data, followed by a newline, to all the clients connected to a server. Prints numbers as a sequence of digits, each an ASCII character (e.g. the number 123 is sent as the three characters ‘1’, ‘2’, ‘3’).
Syntax¶
server.println()
server.println(data)
server.println(data, BASE)
Parameters¶
data (optional): the data to print (char, byte, int, long, or string)
BASE (optional): the base in which to print numbers: DEC for decimal (base 10), OCT for octal (base 8), HEX for hexadecimal (base 16).
Returns¶
byte
println() will return the number of bytes written, though reading that number is optional
server.available()¶
Description¶
Gets a client that is connected to the server and has data available for reading. The connection persists when the returned client object goes out of scope; you can close it by calling client.stop().
available() inherits from the Stream utility class.
Syntax¶
server.available()
Parameters¶
None
Returns¶
a Client object; if no Client has data available for reading, this object will evaluate to false in an if-statement
Example¶
#include <SPI.h>
#include <NINA.h>
char ssid[] = "Network"; // your network SSID (name)
char pass[] = "myPassword"; // your network password
int status = WL_IDLE_STATUS;
WiFiServer server(80);
void setup() {
// initialize serial:
Serial.begin(9600);
Serial.println("Attempting to connect to WPA network...");
Serial.print("SSID: ");
Serial.println(ssid);
status = WiFi.begin(ssid, pass);
if ( status != WL_CONNECTED) {
Serial.println("Couldn't get a WiFi connection");
while(true);
}
else {
server.begin();
Serial.print("Connected to WiFi. My address:");
IPAddress myAddress = WiFi.localIP();
Serial.println(myAddress);
}
}
void loop() {
// listen for incoming clients
WiFiClient client = server.available();
if (client) {
if (client.connected()) {
Serial.println("Connected to client");
}
// close the connection:
client.stop();
}
}
server.accept()¶
Description¶
The traditional server.available() function would only tell you of a new client after it sent data, which makes some protocols like FTP impossible to properly implement.
The intention is programs will use either available() or accept(), but not both. With available(), the client connection continues to be managed by WiFiServer. You don’t need to keep a client object, since calling available() will give you whatever client has sent data. Simple servers can be written with very little code using available().
With accept(), WiFiServer gives you the client only once, regardless of whether it has sent any data. You must keep track of the connected clients. This requires more code, but you gain more control.
Syntax¶
server.accept()
Parameters¶
none
Returns¶
a Client object. If no client has data available for reading, this object will evaluate to false in an if-statement. (WiFiClient).
Example¶
#include <SPI.h>
#include <WiFiNINA.h>
char ssid[] = "Network"; // your network SSID (name)
char pass[] = "myPassword"; // your network password
int status = WL_IDLE_STATUS;
// telnet defaults to port 23
WiFiServer server(23);
WiFiClient clients[8];
void setup() {
//Initialize serial and wait for port to open:
Serial.begin(9600);
while (!Serial) {
; // wait for serial port to connect. Needed for native USB port only
}
// attempt to connect to WiFi network:
status = WiFi.begin(ssid, pass);
if ( status != WL_CONNECTED) {
Serial.println("Couldn't get a WiFi connection");
while(true);
}
// start the server:
server.begin();
Serial.print("Chat server address:");
Serial.println(WiFi.localIP());
}
void loop() {
// check for any new client connecting, and say hello (before any incoming data)
WiFiClient newClient = server.accept();
if (newClient) {
for (byte i=0; i < 8; i++) {
if (!clients[i]) {
Serial.print("We have a new client #");
Serial.println(i);
newClient.print("Hello, client number: ");
newClient.println(i);
// Once we "accept", the client is no longer tracked by WiFiServer
// so we must store it into our list of clients
clients[i] = newClient;
break;
}
}
}
// check for incoming data from all clients
for (byte i=0; i < 8; i++) {
if (clients[i] && clients[i].available() > 0) {
// read bytes from a client
byte buffer[80];
int count = clients[i].read(buffer, 80);
// write the bytes to all other connected clients
for (byte j=0; j < 8; j++) {
if (j != i && clients[j].connected()) {
clients[j].write(buffer, count);
}
}
}
}
// stop any clients which disconnect
for (byte i=0; i < 8; i++) {
if (clients[i] && !clients[i].connected()) {
Serial.print("disconnect client #");
Serial.println(i);
clients[i].stop();
}
}
}
server.peek()¶
Description¶
Read a byte from the file without advancing to the next one. That is, successive calls to peek() will return the same value, as will the next call to read().
This function inherited from the Stream class. See the Stream class main page for more information.
Syntax¶
server.peek()
Parameters¶
None
Returns¶
b: the next byte or character
-1: if none is available
Example¶
…
#include <SPI.h>
#include <BetterWiFiNINA.h>
char ssid[] = SECRET_SSID; // your network SSID (name)
char pass[] = SECRET_PASS; // your network password
int status = WL_IDLE_STATUS;
WiFiServer server(80);
void setup() {
Serial.begin(9600);
while (!Serial) {
}
if (WiFi.status() == WL_NO_MODULE) {
Serial.println("Communication with WiFi module failed!");
// don't continue
while (true);
}
while (status != WL_CONNECTED) {
Serial.print("Attempting to connect to SSID: ");
Serial.println(ssid);
status = WiFi.begin(ssid, pass);
delay(10000);
}
server.begin();
}
void loop() {
// listen for incoming clients
WiFiClient client = server.available();
if (client) {
Serial.println("new client");
// an http request ends with a blank line
boolean currentLineIsBlank = true;
int i = 0;
while (client.connected()) {
if (client.available()) {
char c = client.peek();
Serial.print("peek: ");
Serial.println(c);
Serial.print("calling a second time peek, the char is the same: ");
c = client.peek();
Serial.println(c);
Serial.print("calling the read retry the char and erase from the buffer: ");
c = client.read();
Serial.println(c);
if (i == 2) {
while (1);
}
i++;
if (c == '\n') {
// you're starting a new line
currentLineIsBlank = true;
} else if (c != '\r') {
// you've gotten a character on the current line
currentLineIsBlank = false;
}
}
}
// give the web browser time to receive the data
delay(1);
// close the connection:
client.stop();
Serial.println("client disconnected");
}
}
…