[en] This class can send and receive UDP packets to a specific Internet IP address and port.
[ja] 特定のインターネットIPアドレスとポートに対してUDPパケットの送受信ができます。 More...

#include <LTEUDP.h>

Inheritance diagram for LTEUDP:

[legend]

Collaboration diagram for LTEUDP:

[legend]

Public Member Functions
	LTEUDP ()
	Construct LTEUDP instance.

	~LTEUDP ()
	Destruct LTEUDP instance.

uint8_t	begin (uint16_t port)
	Initialize, start listening on specified port. More...

void	stop ()
	Finish with the UDP socket. More...

int	beginPacket (IPAddress ip, uint16_t port)
	Start building up a packet to send to the remote host specific in ip and port. More...

int	beginPacket (const char *host, uint16_t port)
	Start building up a packet to send to the remote host specific in host and port. More...

int	endPacket ()
	Finish off this packet and send it. More...

size_t	write (uint8_t val)
	Write a single byte into the packet. More...

size_t	write (const uint8_t *buffer, size_t size)
	Write series of bytes from buffer into the packet. More...

int	parsePacket ()
	Start processing the next available incoming packet. More...

int	available ()
	Returns number of bytes remaining in the current packet. More...

int	read ()
	Read a single byte from the current packet. More...

int	read (unsigned char *buffer, size_t len)
	Read up to len bytes from the current packet and place them into buffer. More...

int	read (char *buffer, size_t len)
	Read up to len characters from the current packet and place them into buffer. More...

int	peek ()
	Return the next byte from the current packet without removing it. More...

void	flush ()
	Discards any bytes that have been written to the packet. More...

IPAddress	remoteIP ()
	Return the IP address of the host who sent the current incoming packet. More...

uint16_t	remotePort ()
	Return the port of the host who sent the current incoming packet. More...

int	setTimeout (uint32_t milliseconds)
	Set the timeout when send or receive. More...

Detailed Description

[en] This class can send and receive UDP packets to a specific Internet IP address and port.
[ja] 特定のインターネットIPアドレスとポートに対してUDPパケットの送受信ができます。

Member Function Documentation

◆ begin()

uint8_t LTEUDP::begin ( uint16_t port )

Initialize, start listening on specified port.

[en] Initialize, start listening on specified port.

[ja] クラスの初期化及び指定されたポートの接続を待ちます。

Parameters

[in] port [en] Local port.
[ja] ローカルポート番号。

Returns: [en] Returns 1 if successful, 0 if there are no sockets available to use.; [ja] 成功した場合は1、使用可能なソケットがない場合は0を返します。

◆ stop()

void LTEUDP::stop ( )

Finish with the UDP socket.

[en] Finish with the UDP socket.

[ja] UDPソケットを閉じて終了します。

◆ beginPacket() [1/2]

int LTEUDP::beginPacket	(	IPAddress	ip,
		uint16_t	port
	)

Start building up a packet to send to the remote host specific in ip and port.

[en] Start building up a packet to send to the remote host specific in ip and port.

[ja] 指定されたIPアドレスおよびポート番号でリモートホストに送信するパケットの構築を開始します。

Parameters

[in]	ip	[en] Remote IP address. [ja] リモートIPアドレス。
[in]	port	[en] Remote port. [ja] リモートポート番号。

Returns: [en] Returns 1 if successful, 0 if there was a problem with the supplied IP address or port.; [ja] 成功した場合は1、指定されたIPアドレスまたはポート番号に問題があった場合は0を返します。

◆ beginPacket() [2/2]

int LTEUDP::beginPacket	(	const char *	host,
		uint16_t	port
	)

Start building up a packet to send to the remote host specific in host and port.

[en] Start building up a packet to send to the remote host specific in host and port.

[ja] 指定されたホスト名およびポート番号でリモートホストに送信するパケットの構築を開始します。

Parameters

[in]	host	[en] Remote host. [ja] リモートホスト名。
[in]	port	[en] Remote port. [ja] リモートポート番号。

Returns: [en] Returns 1 if successful, 0 if there was a problem resolving the hostname or port.; [ja] 成功した場合は1、指定されたホスト名またはポート番号に問題があった場合は0を返します。

◆ endPacket()

int LTEUDP::endPacket ( )

Finish off this packet and send it.

[en] Finish off this packet and send it.

[ja] このパケットを終了して構築したパケットを送信します。

Returns: [en] Returns 1 if the packet was sent successfully, 0 if there was an error.; [ja] パケットが正常に送信された場合は1、エラーがあった場合は0を返します。

◆ write() [1/2]

size_t LTEUDP::write ( uint8_t val )

Write a single byte into the packet.

[en] Write a single byte into the packet.

[ja] パケットに1バイトのデータを書き込みます。

Parameters

[in] val [en] single byte.
[ja] 書き込む値。

Returns: [en] The number of bytes written.; [ja] 書き込まれたバイト数。

◆ write() [2/2]

size_t LTEUDP::write	(	const uint8_t *	buffer,
		size_t	size
	)

Write series of bytes from buffer into the packet.

[en] Write series of bytes from buffer into the packet.

[ja] パケットに一連のデータを書き込みます。

Parameters

[in]	buffer	[en] A buffer to send. [ja] 書き込みバッファー。
[in]	size	[en] The length of the buffer. [ja] 書き込みバッファーの長さ。

Returns: [en] The number of bytes written.; [ja] 書き込まれたバイト数。

◆ parsePacket()

int LTEUDP::parsePacket ( )

Start processing the next available incoming packet.

[en] Start processing the next available incoming packet.

[ja] 次に利用可能な受信パケットの処理を開始します。

Returns: [en] Returns the size of the packet in bytes, or 0 if no packets are available.; [ja] パケットのサイズをバイト単位で返します。利用可能なパケットがない場合は0を返します。

◆ available()

int LTEUDP::available ( )

Returns number of bytes remaining in the current packet.

[en] Returns number of bytes remaining in the current packet.

[ja] パケットの残りバイト数を返します。

Returns: [en] The number of bytes available.; [ja] 読出し可能バイト数。

◆ read() [1/3]

int LTEUDP::read ( )

Read a single byte from the current packet.

[en] Read a single byte from the current packet.

[ja] 現在のパケットから1バイトを読み出します。

Returns: [en] The next byte, or -1 if none is available.; [ja] 読み出した値。読み出し可能なものがない場合は-1を返します。

◆ read() [2/3]

int LTEUDP::read	(	unsigned char *	buffer,
		size_t	len
	)

Read up to len bytes from the current packet and place them into buffer.

[en] Read up to len bytes from the current packet and place them into buffer.

[ja] 現在のパケットから最大lenバイトをバッファーに読み出します。

Parameters

[out]	buffer	[en] A buffer to read. [ja] 受信バッファー。
[in]	len	[en] The length of the buffer. [ja] 受信バッファーの長さ。

Returns: [en] Returns the number of bytes read, or -1 if none are available.; [ja] 読み出したバイト数を返します。読み出し可能なものがない場合は-1を返します。

◆ read() [3/3]

int LTEUDP::read	(	char *	buffer,
		size_t	len
	)

Read up to len characters from the current packet and place them into buffer.

[en] Read up to len characters from the current packet and place them into buffer.

[ja] 現在のパケットから最大len文字をバッファーに読み出します。

Parameters

[out]	buffer	[en] A buffer to read. [ja] 受信バッファー。
[in]	len	[en] The length of the buffer. [ja] 受信バッファーの長さ。

Returns: [en] Returns the number of characters read, or -1 if none are available.; [ja] 読み出した文字数を返します。読み出し可能なものがない場合は-1を返します。

◆ peek()

int LTEUDP::peek ( )

Return the next byte from the current packet without removing it.

[en] Return the next byte from the current packet without removing it.

[ja] 現在のパケットから削除せずにデータを読み出します。

Returns: [en] The next byte received, or -1 if none is available.; [ja] 読み出したデータを返します。読み出し可能なものがない場合は-1を返します。

◆ flush()

void LTEUDP::flush ( )

Discards any bytes that have been written to the packet.

[en] Discards any bytes that have been written to the packet.

[ja] パケットに書き込まれたデータを破棄します。

◆ remoteIP()

IPAddress LTEUDP::remoteIP ( )

Return the IP address of the host who sent the current incoming packet.

[en] Return the IP address of the host who sent the current incoming packet.

[ja] 現在の受信パケットを送信したホストのIPアドレスを返します。

Returns: [en] Remote IP address.; [ja] リモートIPアドレス。

◆ remotePort()

uint16_t LTEUDP::remotePort ( )

Return the port of the host who sent the current incoming packet.

[en] Return the port of the host who sent the current incoming packet.

[ja] 現在の受信パケットを送信したホストのポート番号を返します。

Returns: [en] Remote port.; [ja] リモートポート番号。

◆ setTimeout()

int LTEUDP::setTimeout ( uint32_t milliseconds )

Set the timeout when send or receive.

[en] Set the timeout send or receive. 0 means disabled (no timeout). If this method has not been called, the timeout is 0.

[ja] 送受信をする際のタイムアウトを設定します。0は無効（タイムアウトしない）を意味します。本メソッドを呼び出さない場合のタイムアウトは0です。

Returns: [en] Returns 0 if succeeded, -1 if not.; [ja] 成功した場合は0を、そうでない場合は-1を返します。

The documentation for this class was generated from the following file:

LTE/src/LTEUDP.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ begin()

◆ stop()

◆ beginPacket() [1/2]

◆ beginPacket() [2/2]

◆ endPacket()

◆ write() [1/2]

◆ write() [2/2]

◆ parsePacket()

◆ available()

◆ read() [1/3]

◆ read() [2/3]

◆ read() [3/3]

◆ peek()

◆ flush()

◆ remoteIP()

◆ remotePort()

◆ setTimeout()