C027 Interface

Dependencies:   C027_Support

Fork of C027Interface by NetworkSocketAPI

Embed: (wiki syntax)

« Back to documentation index

C027Interface Class Reference

C027Interface Class Reference

C027Interface class Implementation of the NetworkInterface for C027. More...

#include <C027Interface.h>

Public Member Functions

 C027Interface (const char *simpin=0, bool debug=false)
 C027Interfacelifetime.
virtual int connect (const char *apn=0, const char *username=0, const char *password=0)
 Start the interface.
virtual int disconnect ()
 Stop the interface.
virtual const char * get_ip_address ()
 Get the internally stored IP address.
virtual const char * get_mac_address ()
 Get the internally stored MAC address.

Protected Member Functions

virtual int socket_open (void **handle, nsapi_protocol_t proto)
 Open a socket.
virtual int socket_close (void *handle)
 Close the socket.
virtual int socket_bind (void *handle, const SocketAddress &address)
 Bind a server socket to a specific port.
virtual int socket_listen (void *handle, int backlog)
 Start listening for incoming connections.
virtual int socket_connect (void *handle, const SocketAddress &address)
 Connects this TCP socket to the server.
virtual int socket_accept (void **handle, void *server)
 Accept a new connection.
virtual int socket_send (void *handle, const void *data, unsigned size)
 Send data to the remote host.
virtual int socket_recv (void *handle, void *data, unsigned size)
 Receive data from the remote host.
virtual int socket_sendto (void *handle, const SocketAddress &address, const void *data, unsigned size)
 Send a packet to a remote endpoint.
virtual int socket_recvfrom (void *handle, SocketAddress *address, void *buffer, unsigned size)
 Receive a packet from a remote endpoint.
virtual void socket_attach (void *handle, void(*callback)(void *), void *data)
 Register a callback on state change of the socket.
virtual NetworkStack * get_stack ()
 Provide access to the NetworkStack object.

Detailed Description

C027Interface class Implementation of the NetworkInterface for C027.

Definition at line 27 of file C027Interface.h.


Constructor & Destructor Documentation

C027Interface ( const char *  simpin = 0,
bool  debug = false 
)

C027Interfacelifetime.

Parameters:
simpinOptional PIN for the SIM
debugEnable debugging

Definition at line 22 of file C027Interface.cpp.


Member Function Documentation

int connect ( const char *  apn = 0,
const char *  username = 0,
const char *  password = 0 
) [virtual]

Start the interface.

Parameters:
apnOptional name of the network to connect to
usernameOptional username for your APN
passwordOptional password for your APN
Returns:
0 on success, negative error code on failure

Definition at line 28 of file C027Interface.cpp.

int disconnect (  ) [virtual]

Stop the interface.

Returns:
0 on success, negative on failure

Definition at line 64 of file C027Interface.cpp.

const char * get_ip_address (  ) [virtual]

Get the internally stored IP address.

Returns:
IP address of the interface or null if not yet connected

Definition at line 73 of file C027Interface.cpp.

const char * get_mac_address (  ) [virtual]

Get the internally stored MAC address.

Returns:
MAC address of the interface

Definition at line 78 of file C027Interface.cpp.

virtual NetworkStack* get_stack (  ) [protected, virtual]

Provide access to the NetworkStack object.

Returns:
The underlying NetworkStack object

Definition at line 163 of file C027Interface.h.

int socket_accept ( void **  handle,
void *  server 
) [protected, virtual]

Accept a new connection.

Parameters:
handleHandle in which to store new socket
serverSocket handle to server to accept from
Returns:
0 on success, negative on failure
Note:
This call is not-blocking, if this call would block, must immediately return NSAPI_ERROR_WOULD_WAIT

Definition at line 140 of file C027Interface.cpp.

void socket_attach ( void *  handle,
void(*)(void *)  callback,
void *  data 
) [protected, virtual]

Register a callback on state change of the socket.

Parameters:
handleSocket handle
callbackFunction to call on state change
dataArgument to pass to callback
Note:
Callback may be called in an interrupt context.

Definition at line 218 of file C027Interface.cpp.

int socket_bind ( void *  handle,
const SocketAddress &  address 
) [protected, virtual]

Bind a server socket to a specific port.

Parameters:
handleSocket handle
addressLocal address to listen for incoming connections on
Returns:
0 on success, negative on failure.

Definition at line 119 of file C027Interface.cpp.

int socket_close ( void *  handle ) [protected, virtual]

Close the socket.

Parameters:
handleSocket handle
Returns:
0 on success, negative on failure
Note:
On failure, any memory associated with the socket must still be cleaned up

Definition at line 110 of file C027Interface.cpp.

int socket_connect ( void *  handle,
const SocketAddress &  address 
) [protected, virtual]

Connects this TCP socket to the server.

Parameters:
handleSocket handle
addressSocketAddress to connect to
Returns:
0 on success, negative on failure

Definition at line 129 of file C027Interface.cpp.

int socket_listen ( void *  handle,
int  backlog 
) [protected, virtual]

Start listening for incoming connections.

Parameters:
handleSocket handle
backlogNumber of pending connections that can be queued up at any one time [Default: 1]
Returns:
0 on success, negative on failure

Definition at line 124 of file C027Interface.cpp.

int socket_open ( void **  handle,
nsapi_protocol_t  proto 
) [protected, virtual]

Open a socket.

Parameters:
handleHandle in which to store new socket
protoType of socket to open, NSAPI_TCP or NSAPI_UDP
Returns:
0 on success, negative on failure

Definition at line 90 of file C027Interface.cpp.

int socket_recv ( void *  handle,
void *  data,
unsigned  size 
) [protected, virtual]

Receive data from the remote host.

Parameters:
handleSocket handle
dataThe buffer in which to store the data received from the host
sizeThe maximum length of the buffer
Returns:
Number of received bytes on success, negative on failure
Note:
This call is not-blocking, if this call would block, must immediately return NSAPI_ERROR_WOULD_WAIT

Definition at line 157 of file C027Interface.cpp.

int socket_recvfrom ( void *  handle,
SocketAddress *  address,
void *  buffer,
unsigned  size 
) [protected, virtual]

Receive a packet from a remote endpoint.

Parameters:
handleSocket handle
addressDestination for the remote SocketAddress or null
bufferThe buffer for storing the incoming packet data If a packet is too long to fit in the supplied buffer, excess bytes are discarded
sizeThe length of the buffer
Returns:
the number of received bytes on success, negative on failure
Note:
This call is not-blocking, if this call would block, must immediately return NSAPI_ERROR_WOULD_WAIT

Definition at line 187 of file C027Interface.cpp.

int socket_send ( void *  handle,
const void *  data,
unsigned  size 
) [protected, virtual]

Send data to the remote host.

Parameters:
handleSocket handle
dataThe buffer to send to the host
sizeThe length of the buffer to send
Returns:
Number of written bytes on success, negative on failure
Note:
This call is not-blocking, if this call would block, must immediately return NSAPI_ERROR_WOULD_WAIT

Definition at line 145 of file C027Interface.cpp.

int socket_sendto ( void *  handle,
const SocketAddress &  address,
const void *  data,
unsigned  size 
) [protected, virtual]

Send a packet to a remote endpoint.

Parameters:
handleSocket handle
addressThe remote SocketAddress
dataThe packet to be sent
sizeThe length of the packet to be sent
Returns:
the number of written bytes on success, negative on failure
Note:
This call is not-blocking, if this call would block, must immediately return NSAPI_ERROR_WOULD_WAIT

Definition at line 172 of file C027Interface.cpp.