---
name: "ost_SSLStream"
section: "3"
platform: "linux"
package: "libcommoncpp2-doc"
version: "1.8.1-10"
release: "Debian 11 (Bullseye)"
platforms: ["linux"]
url: "https://new.carta.tech/ost_SSLStream"
---

# ost\_SSLStream(3)

## NAME

ost::SSLStream

## SYNOPSIS

`#include <ssl.h>`

Inherits **ost::TCPStream**.

### Public Member Functions

**SSLStream** (**Family** **family**=**IPV4**, bool throwflag=true, **timeout\_t** to=0)\
 void **disconnect** (void)\
 **SSLStream** (const **IPV4Host** &host, **tpport\_t** port, unsigned mss=536, bool throwflag=true, **timeout\_t** to=0)\
 **SSLStream** (const **IPV6Host** &host, **tpport\_t** port, unsigned mss=536, bool throwflag=true, **timeout\_t** to=0)\
 **SSLStream** (const char \*name, **Family** **family**=**IPV4**, unsigned mss=536, bool throwflag=false, **timeout\_t** to=0)\
 **SSLStream** (const **SSLStream** &**ssl**)\
 bool **isSSL** (void)\
 bool **getSession** (void)\
 void **endStream** (void)\
 virtual **~SSLStream** ()\
 ssize\_t **readLine** (char \*str, size\_t max, **timeout\_t** to=0)\
 ssize\_t **readData** (void \*buf, size\_t len, char separator=0, **timeout\_t** to=0)\
 ssize\_t **writeData** (void \*buf, size\_t len, **timeout\_t** to=0)\

### Protected Attributes

SSL \* **ssl**\

### Additional Inherited Members

## Constructor & Destructor Documentation

### ost::SSLStream::SSLStream (Family family = IPV4, bool throwflag = `true`, timeout\_t to = `0`)

### ost::SSLStream::SSLStream (const IPV4Host & host, tpport\_t port, unsigned mss = `536`, bool throwflag = `true`, timeout\_t to = `0`)

### ost::SSLStream::SSLStream (const IPV6Host & host, tpport\_t port, unsigned mss = `536`, bool throwflag = `true`, timeout\_t to = `0`)

### ost::SSLStream::SSLStream (const char \* name, Family family = IPV4, unsigned mss = `536`, bool throwflag = `false`, timeout\_t to = `0`)

### ost::SSLStream::SSLStream (const SSLStream & ssl)

### virtual ost::SSLStream::~SSLStream ()` [virtual]`

## Member Function Documentation

### void ost::SSLStream::disconnect (void)

### void ost::SSLStream::endStream (void)

### bool ost::SSLStream::getSession (void)

### bool ost::SSLStream::isSSL (void)` [inline]`

References ssl.

### ssize\_t ost::SSLStream::readData (void \* buf, size\_t len, char separator = `0`, timeout\_t to = `0`)` [virtual]`

Reimplemented from **ost::Socket**.

### ssize\_t ost::SSLStream::readLine (char \* str, size\_t max, timeout\_t to = `0`)

### ssize\_t ost::SSLStream::writeData (void \* buf, size\_t len, timeout\_t to = `0`)

## Member Data Documentation

### SSL\* ost::SSLStream::ssl` [protected]`

Referenced by isSSL().

## Author

Generated automatically by Doxygen for GNU CommonC++ from the source code.