TCP socket connection. More...

#include <HTTPSClient.h>

Public Member Functions
	HTTPSClient ()
	TCP socket connection.
int	connect (const char *host)
	Connects this TCP socket to the server.
bool	is_connected (void)
	Check if the socket is connected.
void	close ()
	Close the socket.
int	open (NetworkStack *stack)
	Opens a socket.
int	close (bool shutdown=true)
	Close the socket.
int	bind (uint16_t port)
	Bind a specific address to a socket.
int	bind (const char *address, uint16_t port)
	Bind a specific address to a socket.
int	bind (const SocketAddress &address)
	Bind a specific address to a socket.
void	set_blocking (bool blocking)
	Set blocking or non-blocking mode of the socket.
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.
void	set_timeout (int timeout)
	Set timeout on blocking socket operations.
void	attach (mbed::Callback< void()> func)
	Register a callback on state change of the socket.
template<typename T , typename M >
	MBED_DEPRECATED_SINCE ("mbed-os-5.1","The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method)).") void attach(T *obj
	Register a callback on state change of the socket.
int	set_option (int level, int optname, const void *optval, socklen_t optlen)
	Set socket options.
int	get_option (int level, int optname, void optval, socklen_t optlen)
	Get socket options.
void	reset_address (void)
	Reset the address of this endpoint.
int	set_address (const char *host, const int port)
	Set the address of this endpoint.
char *	get_address (void)
	Get the IP address of this endpoint.
int	get_port (void)
	Get the port of this endpoint.

Detailed Description

TCP socket connection.

Definition at line 12 of file HTTPSClient.h.

Constructor & Destructor Documentation

HTTPSClient ( )

TCP socket connection.

Definition at line 16 of file HTTPSClient.cpp.

Member Function Documentation

void attach ( mbed::Callback< void()> func ) [inherited]

Register a callback on state change of the socket.

The specified callback will be called on state changes such as when the socket can recv/send/accept successfully and on when an error occurs. The callback may also be called spuriously without reason.

The callback may be called in an interrupt context and should not perform expensive operations such as recv/send calls.

Parameters:

func	Function to call on state change

int bind ( uint16_t port ) [inherited]

Bind a specific address to a socket.

Binding a socket specifies the address and port on which to recieve data.

Parameters:

port	Local port to bind

Returns:: 0 on success, negative error code on failure.

Definition at line 72 of file features/net/network-socket/Socket.cpp.

int bind	(	const char *	address,
		uint16_t	port
	)		`[inherited]`

Bind a specific address to a socket.

Binding a socket specifies the address and port on which to recieve data. If the IP address is zeroed, only the port is bound.

Parameters:

address	Null-terminated local address to bind
port	Local port to bind

Returns:: 0 on success, negative error code on failure.

Definition at line 79 of file features/net/network-socket/Socket.cpp.

int bind ( const SocketAddress & address ) [inherited]

Bind a specific address to a socket.

Binding a socket specifies the address and port on which to recieve data. If the IP address is zeroed, only the port is bound.

Parameters:

address Local address to bind

Returns:: 0 on success, negative error code on failure.

Definition at line 86 of file features/net/network-socket/Socket.cpp.

int close ( bool shutdown = true ) [inherited]

Close the socket.

Parameters:

shutdown free the left-over data in message queues

Definition at line 72 of file libraries/net/lwip/Socket/Socket.cpp.

void close ( void )

Close the socket.

Closes any open connection and deallocates any memory associated with the socket. Called from destructor if socket is not closed.

Returns:: 0 on success, negative error code on failure

Reimplemented from Socket.

Definition at line 155 of file HTTPSClient.cpp.

int connect ( const char * host )

Connects this TCP socket to the server.

Parameters:

host	The host to connect to. It can either be an IP Address or a hostname that will be resolved with DNS.
port	The host's port to connect to.

Returns:: 0 on success, -1 on failure.

Definition at line 27 of file HTTPSClient.cpp.

char * get_address ( void ) [inherited]

Get the IP address of this endpoint.

Returns:: The IP address of this endpoint.

Definition at line 65 of file Endpoint.cpp.

int get_option	(	int	level,
		int	optname,
		void *	optval,
		socklen_t *	optlen
	)		`[inherited]`

Get socket options.

Parameters:

level	stack level (see: lwip/sockets.h)
optname	option ID
optval	buffer pointer where to write the option value
socklen_t	length of the option value

Returns:: 0 on success, -1 on failure

Definition at line 48 of file libraries/net/lwip/Socket/Socket.cpp.

int get_port ( void ) [inherited]

Get the port of this endpoint.

Returns:: The port of this endpoint

Definition at line 71 of file Endpoint.cpp.

bool is_connected ( void )

Check if the socket is connected.

Returns:: true if connected, false otherwise.

Definition at line 60 of file HTTPSClient.cpp.

MBED_DEPRECATED_SINCE	(	"mbed-os-5.1"	,
		"The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method))."
	)		`[inherited]`

Register a callback on state change of the socket.

The specified callback will be called on state changes such as when the socket can recv/send/accept successfully and on when an error occurs. The callback may also be called spuriously without reason.

The callback may be called in an interrupt context and should not perform expensive operations such as recv/send calls.

Parameters:

obj	Pointer to object to call method on
method	Method to call on state change

int open ( NetworkStack * stack ) [inherited]

Opens a socket.

Creates a network socket on the network stack of the given network interface. Not needed if stack is passed to the socket's constructor.

Parameters:

stack Network stack as target for socket

Returns:: 0 on success, negative error code on failure

Definition at line 27 of file features/net/network-socket/Socket.cpp.

void reset_address ( void ) [inherited]

Reset the address of this endpoint.

Definition at line 28 of file Endpoint.cpp.

int set_address	(	const char *	host,
		const int	port
	)		`[inherited]`

Set the address of this endpoint.

Parameters:

host	The endpoint address (it can either be an IP Address or a hostname that will be resolved with DNS).
port	The endpoint port

Returns:: 0 on success, -1 on failure (when an hostname cannot be resolved by DNS).

Definition at line 35 of file Endpoint.cpp.

void set_blocking ( bool blocking ) [inherited]

Set blocking or non-blocking mode of the socket.

Initially all sockets are in blocking mode. In non-blocking mode blocking operations such as send/recv/accept return NSAPI_ERROR_WOULD_BLOCK if they can not continue.

set_blocking(false) is equivalent to set_timeout(-1) set_blocking(true) is equivalent to set_timeout(0)

Parameters:

blocking true for blocking mode, false for non-blocking mode.

Definition at line 101 of file features/net/network-socket/Socket.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:

blocking	true for blocking mode, false for non-blocking mode.
timeout	timeout in ms [Default: (1500)ms].

Definition at line 27 of file libraries/net/lwip/Socket/Socket.cpp.

int set_option	(	int	level,
		int	optname,
		const void *	optval,
		socklen_t	optlen
	)		`[inherited]`

Set socket options.

Parameters:

level	stack level (see: lwip/sockets.h)
optname	option ID
optval	option value
socklen_t	length of the option value

Returns:: 0 on success, -1 on failure

Definition at line 44 of file libraries/net/lwip/Socket/Socket.cpp.

void set_timeout ( int timeout ) [inherited]

Set timeout on blocking socket operations.

Initially all sockets have unbounded timeouts. NSAPI_ERROR_WOULD_BLOCK is returned if a blocking operation takes longer than the specified timeout. A timeout of 0 removes the timeout from the socket. A negative value give the socket an unbounded timeout.

set_timeout(0) is equivalent to set_blocking(false) set_timeout(-1) is equivalent to set_blocking(true)

Parameters:

timeout Timeout in milliseconds

Definition at line 107 of file features/net/network-socket/Socket.cpp.

Type:	Program
Created:	22 Oct 2016
Imports:	1
Forks:	1
Commits:	10
Dependents:	0
Dependencies:	3
Followers:	1

Important changes to repositories hosted on mbed.com

HTTPSClient Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Important changes to repositories hosted on mbed.com

HTTPSClient Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning