local fork

Dependencies:   Socket USBHostWANDongle_bleedingedge lwip-sys lwip

Dependents:   Encrypted

Fork of VodafoneUSBModem_bleedingedge by Donatien Garnier

Embed: (wiki syntax)

« Back to documentation index

PPPIPInterface Class Reference

PPPIPInterface Class Reference

Interface using PPP to connect to an IP-based network. More...

#include <PPPIPInterface.h>

Inherits LwIPInterface.

Friends

u32_t sio_write (sio_fd_t fd, u8_t *data, u32_t len)
 Writes to the serial device.
u32_t sio_read (sio_fd_t fd, u8_t *data, u32_t len)
 Reads from the serial device.
void sio_read_abort (sio_fd_t fd)
 Aborts a blocking sio_read() call.

Detailed Description

Interface using PPP to connect to an IP-based network.

Definition at line 38 of file PPPIPInterface.h.


Friends And Related Function Documentation

u32_t sio_read ( sio_fd_t  fd,
u8_t *  data,
u32_t  len 
) [friend]

Reads from the serial device.

Parameters:
fdserial device handle
datapointer to data buffer for receiving
lenmaximum length (in bytes) of data to receive
Returns:
number of bytes actually received - may be 0 if aborted by sio_read_abort
Note:
This function will block until data can be received. The blocking can be cancelled by calling sio_read_abort().

Definition at line 423 of file PPPIPInterface.cpp.

void sio_read_abort ( sio_fd_t  fd ) [friend]

Aborts a blocking sio_read() call.

Parameters:
fdserial device handle

Definition at line 446 of file PPPIPInterface.cpp.

u32_t sio_write ( sio_fd_t  fd,
u8_t *  data,
u32_t  len 
) [friend]

Writes to the serial device.

Parameters:
fdserial device handle
datapointer to data to send
lenlength (in bytes) of data to send
Returns:
number of bytes actually sent
Note:
This function will block until all data can be sent.

Definition at line 397 of file PPPIPInterface.cpp.