Junichi Katsu / SimpleIoTBoardLib

Simple IoT Board用のライブラリです。 ESP8266ライブラリの軽量化 送信のみのソフトシリアルライブラリを含んでいます。

Dependents:   SITB_HttpGetSample SITB_IFTTTSample SITB_INA226PRC AmbientExampleSITB ... more

Embed: (wiki syntax)

« Back to documentation index

UDPSocket Class Reference
Public Member Functions

UDPSocket Class Reference

UDP Socket. More...

#include <UDPSocket.h>

Inherits Socket.

Public Member Functions

 UDPSocket ()
 Instantiate an UDP Socket.
int init (void)
 Init the UDP Client Socket without binding it to any specific port.
int bind (int port=-1)
 Bind a UDP Server Socket to a specific port.
int sendTo (Endpoint &remote, char *packet, int length)
 Send a packet to a remote endpoint.
int receiveFrom (Endpoint &remote, char *buffer, int length)
 Receive a packet from a remote endpoint.
void set_blocking (bool blocking, unsigned int timeout=1500)
 Set blocking or non-blocking mode of the socket and a timeout on blocking socket operations.
int close ()
 Close the socket file descriptor.

Detailed Description

UDP Socket.

Definition at line 30 of file UDPSocket.h.

Constructor & Destructor Documentation

UDPSocket (  )

Instantiate an UDP Socket.

Definition at line 24 of file UDPSocket.cpp.

Member Function Documentation

int bind ( int  port = -1 )

Bind a UDP Server Socket to a specific port.

Parameters:
portThe port to listen for incoming connections on
Returns:
0 on success, -1 on failure.

Definition at line 37 of file UDPSocket.cpp.

int close (  ) [inherited]

Close the socket file descriptor.

Definition at line 50 of file Socket.cpp.

int init ( void   )

Init the UDP Client Socket without binding it to any specific port.

Returns:
0 on success, -1 on failure.

Definition at line 31 of file UDPSocket.cpp.

int receiveFrom ( Endpoint &  remote,
char *  buffer,
int  length 
)

Receive a packet from a remote endpoint.

Parameters:
remoteThe remote endpoint
bufferThe buffer for storing the incoming packet data. If a packet is too long to fit in the supplied buffer, excess bytes are discarded
lengthThe length of the buffer
Returns:
the number of received bytes on success (>=0) or -1 on failure

Definition at line 74 of file UDPSocket.cpp.

int sendTo ( Endpoint &  remote,
char *  packet,
int  length 
)

Send a packet to a remote endpoint.

Parameters:
remoteThe remote endpoint
packetThe packet to be sent
lengthThe length of the packet to be sent
Returns:
the number of written bytes on success (>=0) or -1 on failure

wifi->start(ESP_UDP_TYPE, remote._ipAddress, remote._port, remote._id

Definition at line 43 of file UDPSocket.cpp.

void set_blocking ( bool  blocking,
unsigned int  timeout = 1500 
) [inherited]

Set blocking or non-blocking mode of the socket and a timeout on blocking socket operations.

Parameters:
blockingtrue for blocking mode, false for non-blocking mode.
timeouttimeout in ms [Default: (1500)ms].

Definition at line 44 of file Socket.cpp.

Generated on Tue Jul 12 2022 18:13:35 by  doxygen 1.7.2