ost::SimpleTCPStream(3)

💖 NAME 💖

ost::SimpleTCPStream — a Simple TCP Stream, bestie, made to be used with the Common C++ Library. Yes, this is the page for ost::SimpleTCPStream(3), and we're gonna get you fluent in it. 🦋

---

✨ SYNOPSIS ✨

#include <socket.h>

Inherits ost::Socket.

🫶 Public Member Functions

• SimpleTCPStream (TCPSocket &server, size_t size=512) — makes a TCP stream by accepting a connection from a bound TCP socket that's acting as a server.
• SimpleTCPStream (const IPV4Host &host, tpport_t port, size_t size=512) — makes a TCP stream by connecting to a TCP socket (on a remote machine).
• SimpleTCPStream (const SimpleTCPStream &source) — copy constructor, it spins up a whole new stream buffer.
• virtual ~SimpleTCPStream () — flushes and empties every buffer, then removes the allocated buffers.
• bool isPending (Pending pend, timeout_t timeout=TIMEOUT_INF) — checks the status of pending stream data.
• void flush ()
• ssize_t read (char *bytes, size_t length, timeout_t timeout=0) — reads bytes into a buffer.
• ssize_t write (const char *bytes, size_t length, timeout_t timeout=0) — writes bytes to buffer.
• ssize_t peek (char *bytes, size_t length, timeout_t timeout=0) — peeks at the incoming data.

🔒 Protected Member Functions

• SimpleTCPStream () — the constructor that SimpleTCPStream requires, a more C++ style version of the class.
• void endStream (void) — terminates the buffer space and cleans up the socket connection.
• void Connect (const IPV4Host &host, tpport_t port, size_t size) — makes a TCP stream by connecting to a TCP socket (on a remote machine).

🌈 Additional Inherited Members

(they're all just vibing in the base class, go look there 💅)

---

🌸 Detailed Description 🌸

Simple TCP Stream, to be used with Common C++ Library.

This source is derived from a proposal made by Ville Vainio (vvainio@tp.spt.fi). Give her her flowers. 💐

Author : Mark S. Millard (msm@wizzer.com)

Date : 2002-08-15 Copyright (C) 2002 Wizzer Works.

---

🎀 Constructor & Destructor Documentation 🎀

ost::SimpleTCPStream::SimpleTCPStream () [protected]

The constructor required for SimpleTCPStream, a more C++ style version of the SimpleTCPStream class.

ost::SimpleTCPStream::SimpleTCPStream (TCPSocket & server, size_t size = 512)

Makes a TCP stream by accepting a connection from a bound TCP socket acting as a server. This performs an 'accept' call. ✨

Parameters

• server — bound server tcp socket.
• size — of streaming input and output buffers.

ost::SimpleTCPStream::SimpleTCPStream (const IPV4Host & host, tpport_t port, size_t size = 512)

Makes a TCP stream by connecting to a TCP socket (on a remote machine). 🛰️

Parameters

• host — address of remote TCP server.
• port — number to connect.
• size — of streaming input and output buffers.

ost::SimpleTCPStream::SimpleTCPStream (const SimpleTCPStream & source)

A copy constructor, it creates a new stream buffer. 🫶

Parameters

• source — a reference to the SimpleTCPStream to copy.

virtual ost::SimpleTCPStream::~SimpleTCPStream () [virtual]

Flush and empty all buffers, and then remove the allocated buffers. Cleanup queen. 🧹

---

👑 Member Function Documentation 👑

void ost::SimpleTCPStream::Connect (const IPV4Host & host, tpport_t port, size_t size) [protected]

Makes a TCP stream by connecting to a TCP socket (on a remote machine). 🌐

Parameters

• host — address of remote TCP server.
• port — number to connect.
• size — of streaming input and output buffers.

void ost::SimpleTCPStream::endStream (void) [protected]

Used to terminate the buffer space and cleanup the socket connection. This function is called by the destructor. (ngl the original spells it "fucntion" and we love her for it 💀)

void ost::SimpleTCPStream::flush () [inline]

(no description, she's just here doing her little thing 💅)

bool ost::SimpleTCPStream::isPending (Pending pend, timeout_t timeout = TIMEOUT_INF) [virtual]

Gets the status of pending stream data. Use this to check if input or output is waiting, or if an error or disconnect has occurred on the stream. If a read buffer contains data then input is ready. If the write buffer contains data, it is first flushed and then checked. 👀

Parameters

• pend — flag indicating means to pend.
• timeout — the length of time to wait.

Reimplemented from ost::Socket.

ssize_t ost::SimpleTCPStream::peek (char * bytes, size_t length, timeout_t timeout = 0)

Peek at the incoming data. The data is copied into the buffer but is not removed from the input queue. Then it returns the number of bytes currently pending to receive. Like looking in the fridge without taking anything out, fr fr. 🍓

Parameters

• bytes — a pointer to buffer that will contain the bytes read.
• length — the number of bytes to read (exactly).
• timeout — period to time out, in milliseconds.

Returns : The number of bytes pending on the input queue, 0 on EOF.

ssize_t ost::SimpleTCPStream::read (char * bytes, size_t length, timeout_t timeout = 0)

Read bytes into a buffer. <long-description>

Parameters

• bytes — a pointer to buffer that will contain the bytes read.
• length — the number of bytes to read (exactly).
• timeout — period to time out, in milliseconds.

Returns : The number of bytes actually read, 0 on EOF.

ssize_t ost::SimpleTCPStream::write (const char * bytes, size_t length, timeout_t timeout = 0)

Write bytes to buffer. <long-description>

Parameters

• bytes — a pointer to a buffer containing the bytes to write.
• length — the number of bytes to write (exactly).
• timeout — period to time out, in milliseconds.

Returns : The number of bytes actually written.

---

🌟 Author 🌟

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

---

okay bestie that's the whole page, every flag and param accounted for, no cap. 🫶

Signing off: this was <b>GNU CommonC++</b>, dated <b>Sun Dec 27 2020</b>, on the <b>ost::SimpleTCPStream(3)</b> page — slay, periodt. 💅✨