ACKme / WiConnect

Host library for controlling a WiConnect enabled Wi-Fi module.

Dependents:   wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more

Embed: (wiki syntax)

« Back to documentation index

Socket Class Reference
Public Member Functions

Socket Class Reference

Socket file descriptor and select wrapper. More...

#include <Socket.h>

Inherited by TCPSocketConnection, TCPSocketServer, and UDPSocket.

Public Member Functions

 Socket ()
 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.
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.
int close (bool shutdown=true)
 Close the socket.

Detailed Description

Socket file descriptor and select wrapper.

Definition at line 41 of file Socket.h.

Constructor & Destructor Documentation

Socket (  )

Socket.

ACKme WiConnect Host Library is licensed under the BSD licence:

Copyright (c)2014 ACKme Networks. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition at line 38 of file Socket.cpp.

Member Function Documentation

int close ( bool  shutdown = true )

Close the socket.

Parameters:
shutdownfree the left-over data in message queues

Definition at line 75 of file Socket.cpp.

int get_option ( int  level,
int  optname,
void *  optval,
socklen_t *  optlen 
)

Get socket options.

Note:
NOT supported in this version.
Parameters:
levelstack level (see: lwip/sockets.h)
optnameoption ID
optvalbuffer pointer where to write the option value
socklen_tlength of the option value
Returns:
0 on success, -1 on failure

Definition at line 69 of file Socket.cpp.

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.

Note:
Currently the blocking/timeout functionality is only supported for 'read' methods
Parameters:
blockingtrue for blocking mode, false for non-blocking mode.
timeouttimeout in ms [Default: (1500)ms].

Definition at line 56 of file Socket.cpp.

int set_option ( int  level,
int  optname,
const void *  optval,
socklen_t  optlen 
)

Set socket options.

Note:
NOT supported in this version.
Parameters:
levelstack level (see: lwip/sockets.h)
optnameoption ID
optvaloption value
socklen_tlength of the option value
Returns:
0 on success, -1 on failure

Definition at line 63 of file Socket.cpp.

Generated on Tue Jul 12 2022 17:35:59 by  doxygen 1.7.2