Arduino  1.8.10
GSM3MobileClientProvider クラスabstract

#include <GSM3MobileClientProvider.h>

GSM3MobileClientProvider の継承関係図
GSM3ShieldV1ClientProvider GSM3ShieldV1MultiClientProvider

公開メンバ関数

 GSM3MobileClientProvider ()
 
virtual int minSocket ()=0
 
virtual int maxSocket ()=0
 
virtual int ready ()=0
 
virtual bool getStatusSocketClient (uint8_t socket)=0
 
virtual int getSocket (int socket=-1)=0
 
virtual void releaseSocket (int socket)=0
 
virtual int connectTCPClient (const char *server, int port, int id_socket)=0
 
virtual int connectTCPClient (IPAddress add, int port, int id_socket)=0
 
virtual void beginWriteSocket (bool client1Server0, int id_socket)=0
 
virtual void writeSocket (uint8_t c)=0
 
virtual void writeSocket (const char *buf)=0
 
virtual void endWriteSocket ()=0
 
virtual int availableSocket (bool client, int id_socket)=0
 
virtual int readSocket ()=0
 
virtual void flushSocket ()=0
 
virtual int peekSocket ()=0
 
virtual int disconnectTCP (bool client1Server0, int idsocket)=0
 

限定公開変数類

uint8_t sockets
 

詳解

GSM3MobileClientProvider.h40 行目に定義があります。

構築子と解体子

◆ GSM3MobileClientProvider()

GSM3MobileClientProvider::GSM3MobileClientProvider ( )
inline

Constructor

GSM3MobileClientProvider.h49 行目に定義があります。

49 {};

関数詳解

◆ availableSocket()

virtual int GSM3MobileClientProvider::availableSocket ( bool  client,
int  id_socket 
)
pure virtual

Check if there are data to be read in socket.

引数
client1Server01 if modem acts as client, 0 if acts as server
id_socketLocal socket number
戻り値
0 if command running, 1 if there are data available, 4 if no data, otherwise error

GSM3ShieldV1MultiClientProvider, GSM3ShieldV1ClientProviderで実装されています。

◆ beginWriteSocket()

virtual void GSM3MobileClientProvider::beginWriteSocket ( bool  client1Server0,
int  id_socket 
)
pure virtual

Begin writing through a socket

引数
client1Server01 if modem acts as client, 0 if acts as server
id_socketLocal socket number
戻り値
0 if command running, 1 if success, otherwise error

GSM3ShieldV1MultiClientProvider, GSM3ShieldV1ClientProviderで実装されています。

◆ connectTCPClient() [1/2]

virtual int GSM3MobileClientProvider::connectTCPClient ( const char *  server,
int  port,
int  id_socket 
)
pure virtual

Connect to a server via TCP connection

引数
serverServer name or IP address in a String
portPort
id_socketSocket
戻り値
0 if command running, 1 if success, otherwise error

GSM3ShieldV1MultiClientProvider, GSM3ShieldV1ClientProviderで実装されています。

◆ connectTCPClient() [2/2]

virtual int GSM3MobileClientProvider::connectTCPClient ( IPAddress  add,
int  port,
int  id_socket 
)
pure virtual

Connect to a server (by IP address) via TCP connection

引数
addIP address in IPAddress format
portPort
id_socketSocket
戻り値
0 if command running, 1 if success, otherwise error

GSM3ShieldV1MultiClientProvider, GSM3ShieldV1ClientProviderで実装されています。

◆ disconnectTCP()

virtual int GSM3MobileClientProvider::disconnectTCP ( bool  client1Server0,
int  idsocket 
)
pure virtual

Close a socket

引数
client1Server01 if modem acts as client, 0 if acts as server
id_socketSocket
戻り値
0 if command running, 1 if success, otherwise error

GSM3ShieldV1MultiClientProvider, GSM3ShieldV1ClientProviderで実装されています。

◆ endWriteSocket()

virtual void GSM3MobileClientProvider::endWriteSocket ( )
pure virtual

Finish current writing

GSM3ShieldV1MultiClientProvider, GSM3ShieldV1ClientProviderで実装されています。

◆ flushSocket()

virtual void GSM3MobileClientProvider::flushSocket ( )
pure virtual

Flush socket

GSM3ShieldV1MultiClientProvider, GSM3ShieldV1ClientProviderで実装されています。

◆ getSocket()

virtual int GSM3MobileClientProvider::getSocket ( int  socket = -1)
pure virtual

Get socket

引数
socketSocket
戻り値
socket

GSM3ShieldV1MultiClientProvider, GSM3ShieldV1ClientProviderで実装されています。

◆ getStatusSocketClient()

virtual bool GSM3MobileClientProvider::getStatusSocketClient ( uint8_t  socket)
pure virtual

Get status socket client

引数
socketSocket
戻り値
1 if connected

GSM3ShieldV1MultiClientProvider, GSM3ShieldV1ClientProviderで実装されています。

◆ maxSocket()

virtual int GSM3MobileClientProvider::maxSocket ( )
inlinepure virtual

Maximum socket

戻り値
socket

GSM3ShieldV1MultiClientProvider, GSM3ShieldV1ClientProviderで実装されています。

◆ minSocket()

virtual int GSM3MobileClientProvider::minSocket ( )
inlinepure virtual

Minimum socket

戻り値
socket

GSM3ShieldV1MultiClientProvider, GSM3ShieldV1ClientProviderで実装されています。

◆ peekSocket()

virtual int GSM3MobileClientProvider::peekSocket ( )
pure virtual

Get a character but will not advance the buffer head

戻り値
character

GSM3ShieldV1MultiClientProvider, GSM3ShieldV1ClientProviderで実装されています。

◆ readSocket()

virtual int GSM3MobileClientProvider::readSocket ( )
pure virtual

Read data (get a character) available in socket

戻り値
character

GSM3ShieldV1MultiClientProvider, GSM3ShieldV1ClientProviderで実装されています。

◆ ready()

virtual int GSM3MobileClientProvider::ready ( )
pure virtual

Get last command status

戻り値
returns 0 if last command is still executing, 1 success, >1 error

GSM3ShieldV1MultiClientProvider, GSM3ShieldV1ClientProviderで実装されています。

◆ releaseSocket()

virtual void GSM3MobileClientProvider::releaseSocket ( int  socket)
pure virtual

Release socket

引数
socketSocket

GSM3ShieldV1MultiClientProvider, GSM3ShieldV1ClientProviderで実装されています。

◆ writeSocket() [1/2]

virtual void GSM3MobileClientProvider::writeSocket ( uint8_t  c)
pure virtual

Write through a socket. MUST go after beginWriteSocket()

引数
ccharacter to be written

GSM3ShieldV1ClientProviderで実装されています。

◆ writeSocket() [2/2]

virtual void GSM3MobileClientProvider::writeSocket ( const char *  buf)
pure virtual

Write through a socket. MUST go after beginWriteSocket()

引数
bufcharacters to be written (final 0 will not be written)

GSM3ShieldV1MultiClientProvider, GSM3ShieldV1ClientProviderで実装されています。

メンバ詳解

◆ sockets

uint8_t GSM3MobileClientProvider::sockets
protected

GSM3MobileClientProvider.h44 行目に定義があります。


このクラス詳解は次のファイルから抽出されました: