UCommon
|
Secure socket buffer. More...
#include <secure.h>
Public Member Functions | |
bool | _flush (void) |
Flush buffer to physical i/o. | |
bool | _pending (void) |
Check for pending tcp or ssl data. | |
size_t | _pull (char *address, size_t size) |
Method to pull buffer from physical i/o (read). | |
size_t | _push (const char *address, size_t size) |
Method to push buffer into physical i/o (write). | |
void | close (void) |
Close active connection. | |
bool | is_secure (void) |
void | open (const char *host, const char *service, size_t size=536) |
Connect a ssl client session to a specific host uri. | |
void | release (void) |
Release (free) buffer memory. | |
SSLBuffer (secure::client_t context) | |
SSLBuffer (const TCPServer *server, secure::server_t context, size_t size=536) | |
![]() | |
void | open (const TCPServer *server, size_t size=536) |
Connect a tcp socket to a client from a listener. | |
TCPBuffer () | |
Construct an unconnected tcp client and specify our service profile. | |
TCPBuffer (const TCPServer *server, size_t size=536) | |
Construct a tcp server session from a listening socket. | |
TCPBuffer (const char *host, const char *service, size_t size=536) | |
Construct a tcp client session connected to a specific host uri. | |
virtual | ~TCPBuffer () |
Destroy the tcp socket and release all resources. | |
![]() | |
int | _getch (void) |
Get a character from the buffer. | |
int | _putch (int ch) |
Put a character into the buffer. | |
bool | eof (void) |
Check if at end of input. | |
int | err (void) |
bool | flush (void) |
Flush buffered memory to physical I/O. | |
size_t | get (char *address, size_t count) |
Get memory from the buffer. | |
size_t | getline (char *string, size_t size) |
Get text as a line of input from the buffer. | |
size_t | getline (string &buffer) |
Get a string as a line of input from the buffer. | |
bool | is_input (void) |
See if input active. | |
bool | is_open (void) |
See if buffer open. | |
bool | is_output (void) |
See if output active. | |
bool | is_pending (void) |
See if pending input. | |
operator bool () | |
See if buffer open. | |
bool | operator! () |
See if buffer closed. | |
size_t | printf (const char *format,...) |
Print formatted string to the buffer. | |
void | purge (void) |
Purge any pending input or output buffer data. | |
size_t | put (const char *address, size_t count=0) |
Put memory into the buffer. | |
size_t | putline (const char *string) |
Put a string as a line of output to the buffer. | |
void | reset (void) |
Reset input buffer state. | |
void | seteof (void) |
Set eof flag. | |
![]() | |
int | get (void) |
Get the next character. | |
int | put (int code) |
Put the next character. |
Protected Attributes | |
secure::bufio_t | bio |
bool | server |
secure::session_t | ssl |
bool | verify |
Additional Inherited Members | |
![]() | |
enum | type_t { BUF_RD, BUF_WR, BUF_RDWR } |
![]() | |
typedef void * | set_t |
External definition of fd_set type. | |
![]() | |
bool | _blocking (void) |
Return true if blocking. | |
void | _buffer (size_t size) |
void | _clear (void) |
Method to clear low level i/o error. | |
int | _err (void) const |
Method to get low level i/o error. | |
socket_t | getsocket (void) const |
Get the low level socket object. | |
![]() | |
static socket_t | acceptfrom (socket_t socket, struct sockaddr_storage *address=((void *) 0)) |
Accept a socket connection from a remote host. | |
static Socket | acceptfrom (Socket &socket, struct sockaddr_storage *address) |
Accept connection through socket. | |
static int | bindto (socket_t socket, const char *address, const char *service, int protocol=0) |
Bind the socket descriptor to a known interface and service port. | |
static int | bindto (socket_t socket, struct sockaddr *address) |
Bind the socket descriptor to a known interface. | |
static int | blocking (socket_t socket, bool enable) |
Set socket blocking I/O mode of socket descriptor. | |
static int | broadcast (socket_t socket, bool enable) |
Set socket for unicast mode broadcasts on socket descriptor. | |
static void | cancel (socket_t socket) |
Cancel pending i/o by shutting down the socket. | |
static void | clear (set_t mask) |
Clear a mask, setting all entries to zero. | |
static void | clear (socket_t socket, set_t mask) |
Clear a socket entry in a mask. | |
static int | connectto (socket_t socket, struct addrinfo *list) |
Connect socket descriptor to a remote host from an address list. | |
static void | connectto (Socket &socket, Socket::address &address) |
Connect a socket. | |
static unsigned | copy (struct sockaddr *target, struct sockaddr *origin) |
Copy a socket address. | |
static socket_t | create (int family, int type, int protocol) |
Create a socket object unbound. | |
static socket_t | create (struct addrinfo *address, int type, int protocol) |
Create a connected socket. | |
static socket_t | create (const char *iface, const char *service, int family=0, int type=0, int protocol=0) |
Create a bound socket for a service. | |
static socket_t | create (Socket::address &address) |
Create a connected socket for a service. | |
static int | disconnect (socket_t socket) |
Disconnect a connected socket descriptor. | |
static void | disconnect (Socket &socket) |
Disconnect a connected socket. | |
static int | drop (socket_t socket, struct addrinfo *list) |
Drop socket descriptor from multicast group. | |
static bool | equal (struct sockaddr *address1, struct sockaddr *address2) |
Compare socket addresses. | |
static bool | equalfrom (struct sockaddr_storage *address1, struct sockaddr_storage *address2) |
Compare socket addresses. | |
static bool | equalhost (struct sockaddr *address1, struct sockaddr *address2) |
Compare socket host addresses. | |
static bool | equalinet (struct sockaddr_internet *address1, struct sockaddr_internet *address2) |
Compare socket addresses. | |
static int | error (socket_t socket) |
Get socket error code of socket descriptor. | |
static int | error (void) |
Return error code of last socket operation,. | |
static void | family (int query) |
Set default socket family preference for query options when the socket type is otherwise not specified. | |
static socklen_t | getaddr (socket_t socket, struct sockaddr_storage *address, const char *hostname, const char *service) |
Lookup a host name and service address based on the addressing family and socket type of a socket descriptor. | |
static struct addrinfo * | getaddress (const char *host, const char *service, int type=SOCK_STREAM, int protocol=0) |
Get an address list directly. | |
static char * | getaddress (struct sockaddr *address, char *buffer, socklen_t size) |
Get the hostname of a socket address. | |
static int | getfamily (socket_t socket) |
Get the address family of the socket descriptor. | |
static int | getfamily (struct sockaddr_storage &address) |
Get the address family of a socket address object. | |
static int | getfamily (struct sockaddr_internet &address) |
Get the address family of an internet socket address object. | |
static struct addrinfo * | gethint (socket_t socket, struct addrinfo *hint) |
Create an address info lookup hint based on the family and type properties of a socket descriptor. | |
static char * | gethostname (struct sockaddr *address, char *buffer, size_t size) |
Lookup and return the host name associated with a socket address. | |
static int | getinterface (struct sockaddr *address, struct sockaddr *destination) |
Get the socket address of the interface needed to reach a destination address. | |
static socklen_t | getlen (struct sockaddr *address) |
Get the size of a socket address. | |
static int | getlocal (socket_t socket, struct sockaddr_storage *address) |
Get local address to which the socket is bound. | |
static set_t | getmask (void) |
Get a mask from the heap. | |
static int | getremote (socket_t socket, struct sockaddr_storage *address) |
Get remote address to which the socket is connected. | |
static short | getservice (struct sockaddr *address) |
Get the service port of a socket. | |
static int | gettype (socket_t socket) |
Get the type of a socket. | |
static short | inetservice (struct sockaddr_internet *address) |
Get the service port of an inet socket. | |
static void | init (void) |
Initialize socket subsystem. | |
static void | init (const char *program) |
Initialize with program name. | |
static bool | isNull (const char *string) |
Simple function to validate that a given IP address string is a "zero" address. | |
static bool | isNumeric (const char *string) |
Simple function to validate that a given IP address string is a numeric address. | |
static int | join (socket_t socket, struct addrinfo *list) |
Join socket descriptor to multicast group. | |
static int | keepalive (socket_t socket, bool enable) |
Set socket for keepalive packets for socket descriptor. | |
static unsigned | keyhost (struct sockaddr *address, unsigned size) |
Convert a socket host address into a hash map index. | |
static unsigned | keyindex (struct sockaddr *address, unsigned size) |
Convert a socket address and service into a hash map index. | |
static int | listento (socket_t socket, struct sockaddr *address, int backlog=5) |
Bind the socket descriptor to a known interface listen on service port. | |
static int | loopback (socket_t socket, bool enable) |
Set loopback to read multicast packets socket descriptor broadcasts. | |
static int | multicast (socket_t socket, unsigned ttl=1) |
Set multicast mode and multicast broadcast range for socket descriptor. | |
static int | nodelay (socket_t socket) |
Set tcp nodelay option on socket descriptor. | |
static unsigned | pending (socket_t socket) |
Get the number of bytes pending in the receive buffer of a socket descriptor. | |
static ssize_t | printf (socket_t socket, const char *format,...) |
Print formatted string to socket. | |
static int | priority (socket_t socket, int scheduling) |
Set packet priority of socket descriptor. | |
static size_t | readfrom (Socket &socket, char *buffer, size_t size, struct sockaddr_storage *address) |
receive from socket object. | |
static ssize_t | readline (socket_t socket, char *data, size_t size, timeout_t timeout=Timer::inf) |
Read a newline of text data from the socket and save in NULL terminated string. | |
static ssize_t | recvfrom (socket_t socket, void *buffer, size_t size, int flags=0, struct sockaddr_storage *address=((void *) 0)) |
Get data waiting in receive queue. | |
static ssize_t | recvinet (socket_t socket, void *buffer, size_t size, int flags=0, struct sockaddr_internet *address=((void *) 0)) |
Get internet data waiting in receive queue. | |
static int | recvsize (socket_t socket, unsigned size) |
Set the receive size of a socket descriptor. | |
static void | release (struct addrinfo *list) |
Release an address list directly. | |
static void | release (socket_t socket) |
Release (close) a socket. | |
static void | release (set_t mask) |
Release a heap allocated mask. | |
static ssize_t | replyto (socket_t socket, const void *buffer, size_t size, int flags, struct sockaddr_storage *address) |
Send reply on socket. | |
static unsigned | segsize (socket_t socket, unsigned size=0) |
Set segment size and get MTU. | |
static int | select (int max, set_t read, set_t write, set_t error) |
Select without timeout. | |
static int | select (int max, set_t read, set_t write, set_t error, timeout_t timeout) |
Select with timeout. | |
static ssize_t | sendinet (socket_t socket, const void *buffer, size_t size, int flags, struct sockaddr_internet *address) |
Send to internet socket. | |
static int | sendsize (socket_t socket, unsigned size) |
Set the send size of a socket descriptor. | |
static ssize_t | sendto (socket_t socket, const void *buffer, size_t size, int flags=0, struct sockaddr *address=((void *) 0)) |
Send data on socket. | |
static int | sendwait (socket_t socket, unsigned size) |
Set the size to wait before sending. | |
static void | set (socket_t socket, set_t mask) |
Set a socket entry in a mask. | |
static bool | setccid (socket_t socket, uint8_t ccid) |
Set congestion control id. | |
static unsigned | store (struct sockaddr_storage *storage, struct sockaddr *address) |
Store an address into an address object. | |
static unsigned | store (struct sockaddr_internet *storage, struct sockaddr *address) |
Store an address into an internet address object. | |
static bool | subnet (struct sockaddr *address1, struct sockaddr *address2) |
See if both addresses are in the same subnet. | |
static bool | test (socket_t socket, set_t mask) |
Test a socket entry in a mask. | |
static int | tos (socket_t socket, int type) |
Set type of service of socket descriptor. | |
static int | ttl (socket_t socket, unsigned char time) |
Set the time to live for the socket descriptor. | |
static void | v4mapping (bool enable) |
Set the default socket behavior for v6-v4 mapping. | |
static bool | wait (socket_t socket, timeout_t timeout=0) |
Test for pending input data. | |
static size_t | writeto (Socket &socket, const char *buffer, size_t size, struct sockaddr *address) |
Send to socket object. | |
![]() | |
static const size_t | masksize |
Secure socket buffer.
This is used to create ssl socket connections for both clients and servers. The use depends in part on the type of context created and passed at construction time. If no context is passed (NULL), then this reverts to TCPBuffer behavior.
|
virtual |
Check for pending tcp or ssl data.
Reimplemented from ucommon::TCPBuffer.
|
virtual |
Method to pull buffer from physical i/o (read).
The address is passed to this virtual since it is hidden as private.
address | of buffer to pull data into. |
size | of buffer area being pulled.. |
Reimplemented from ucommon::TCPBuffer.
|
virtual |
Method to push buffer into physical i/o (write).
The address is passed to this virtual since it is hidden as private.
address | of data to push. |
size | of data to push. |
Reimplemented from ucommon::TCPBuffer.
void ucommon::SSLBuffer::open | ( | const char * | host, |
const char * | service, | ||
size_t | size = 536 |
||
) |
Connect a ssl client session to a specific host uri.
If the socket was already connected, it is automatically closed first.
host | we are connecting to. |
service | to connect to. |
size | of buffer and tcp fragments. |
Reimplemented from ucommon::TCPBuffer.