Class WiFiServer

WiFiServer Class

Description

A class of WiFi server implementation for Ameba.

Syntax

class WiFiServer

Members

Public Constructors
WiFiServer::WiFiServer	Constructs a WiFiServer object and creates a server that listens for incoming connections on the specified port.
Public Methods
WiFiServer::available	Gets a client that is connected to the server and has data available for reading.
WiFiServer::begin	Server start listening for incoming connections.
WiFiServer::write	Write data to all the clients connected to a server.
WiFiServer::stop	Stops a server connection
WiFiServer::setBlockingMode	Set WiFi Server to blocking mode.
WiFiServer:: setNonBlockingMode	Set WiFi Client to non-blocking mode.
WiFiServer::end	Stops server connection
WiFiServer::close	Stops server connection

WiFiServer::WiFiServer

Description

Constructs a WiFiServer object and creates a server that listens for incoming connections on the specified port.

Syntax

WiFiServer (uint16_t port);
WiFiServer(tPortMode portMode);
WiFiServer(tBlockingMode blockMode);
WiFiServer(uint16_t port, tPortMode portMode);
WiFiServer(uint16_t port, tPortMode portMode, tBlockingMode blockMode);

Parameters

port: The port number being connected to.

portMode: 0-TCP_MODE, 1-UDP_MODE

blockMode: 0-BLOCKING_MODE, 1-NON_BLOCKING_MODE

Example Code

Example: SimpleServerWiFi.ino

Note

“WiFiServer.h” must be included to use the class function.

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 the client.stop().

Syntax

WiFiClient available(uint8_t *status = NULL);

Parameters

status: Wi-Fi availability status. Default value is NULL.

Returns

This function returns a client object; if no Client has data available for reading, this object will evaluate to false in an if-statement

Example Code

Example: SimpleServerWiFi.ino

Note

“WiFiServer.h” must be included to use the class function.

WiFiServer::begin

Description

Server start listening for incoming connections.

Syntax

void begin(void);

Parameters

NA

Returns

NA

Example Code

Example: SimpleServerWiFi.ino

Note

“WiFiServer.h” must be included to use the class function.

WiFiServer::connected

Description

Check if server is still connected.

Syntax

uint8_t connected(void);

Parameters

NA

Returns

This function returns “1” if connected, returns “0” if not connected.

Example Code

NA

Note

“WiFiServer.h” must be included to use the class function.

WiFiServer::write

Description

Write data to all the clients connected to a server.

Syntax

virtual size_t write(uint8_t b);

Parameters

b: byte to be written.

buf: data buffer.

size: size of the data buffer.

Returns

This function returns the number of bytes written. It is not necessary to read this.

Example Code

Example: SimpleServerWiFi.ino

Note

“WiFiServer.h” must be included to use the class function.

WiFiServer::stop

Description

Stops a server connection.

Syntax

void stop(void);

Parameters

NA

Returns

NA

Example Code

NA

Note

“WiFiServer.h” must be included to use the class function.

WiFiServer::end

Description

Stops a server connection.

Syntax

void end(void);

Parameters

NA

Returns

NA

Example Code

NA

Note

“WiFiServer.h” must be included to use the class function.

WiFiServer::close

Description

Stops a server connection.

Syntax

void close(void);

Parameters

NA

Returns

NA

Example Code

NA

Note

“WiFiServer.h” must be included to use the class function.

WiFiServer::setBlockingMode

Description

Set WiFi Server to blocking mode.

Syntax

void setBlockingMode(void);

Parameters

NA

Returns

NA

Example Code

NA

WiFiServer::setNonBlockingMode

Description

Set WiFi Server to non-blocking mode.

Syntax

void setNonBlockingMode(void);

Parameters

NA

Returns

NA

Example Code

NA