WPILibC++ 2027.0.0-alpha-4
Loading...
Searching...
No Matches
wpi::net::NetworkStream Class Referenceabstract

#include <wpi/net/NetworkStream.hpp>

Inheritance diagram for wpi::net::NetworkStream:
wpi::net::TCPStream

Public Types

enum  Error { kConnectionClosed = 0 , kConnectionReset = -1 , kConnectionTimedOut = -2 , kWouldBlock = -3 }

Public Member Functions

 NetworkStream ()=default
virtual ~NetworkStream ()=default
virtual size_t send (const char *buffer, size_t len, Error *err)=0
virtual size_t receive (char *buffer, size_t len, Error *err, int timeout=0)=0
virtual void close ()=0
virtual std::string_view getPeerIP () const =0
virtual int getPeerPort () const =0
virtual void setNoDelay ()=0
virtual bool setBlocking (bool enabled)=0
virtual int getNativeHandle () const =0
 NetworkStream (const NetworkStream &)=delete
NetworkStreamoperator= (const NetworkStream &)=delete

Member Enumeration Documentation

◆ Error

Enumerator
kConnectionClosed 
kConnectionReset 
kConnectionTimedOut 
kWouldBlock 

Constructor & Destructor Documentation

◆ NetworkStream() [1/2]

wpi::net::NetworkStream::NetworkStream ( )
default

◆ ~NetworkStream()

virtual wpi::net::NetworkStream::~NetworkStream ( )
virtualdefault

◆ NetworkStream() [2/2]

wpi::net::NetworkStream::NetworkStream ( const NetworkStream & )
delete

Member Function Documentation

◆ close()

virtual void wpi::net::NetworkStream::close ( )
pure virtual

Implemented in wpi::net::TCPStream.

◆ getNativeHandle()

virtual int wpi::net::NetworkStream::getNativeHandle ( ) const
pure virtual

Implemented in wpi::net::TCPStream.

◆ getPeerIP()

virtual std::string_view wpi::net::NetworkStream::getPeerIP ( ) const
pure virtual

Implemented in wpi::net::TCPStream.

◆ getPeerPort()

virtual int wpi::net::NetworkStream::getPeerPort ( ) const
pure virtual

Implemented in wpi::net::TCPStream.

◆ operator=()

NetworkStream & wpi::net::NetworkStream::operator= ( const NetworkStream & )
delete

◆ receive()

virtual size_t wpi::net::NetworkStream::receive ( char * buffer,
size_t len,
Error * err,
int timeout = 0 )
pure virtual

Implemented in wpi::net::TCPStream.

◆ send()

virtual size_t wpi::net::NetworkStream::send ( const char * buffer,
size_t len,
Error * err )
pure virtual

Implemented in wpi::net::TCPStream.

◆ setBlocking()

virtual bool wpi::net::NetworkStream::setBlocking ( bool enabled)
pure virtual

Implemented in wpi::net::TCPStream.

◆ setNoDelay()

virtual void wpi::net::NetworkStream::setNoDelay ( )
pure virtual

Implemented in wpi::net::TCPStream.


The documentation for this class was generated from the following file: