SourcePro® API Reference Guide

 
Loading...
Searching...
No Matches
RWTPortalStreamBase< charT, traits > Class Template Reference

Base class that includes functions common to derived portal stream classes. More...

#include <rw/network/RWTPortalStreamBase.h>

Inheritance diagram for RWTPortalStreamBase< charT, traits >:

Public Member Functions

 RWTPortalStreamBase ()
 
 RWTPortalStreamBase (const RWPortal &)
 
void attach (const RWPortal &p, bool force=false)
 
void detach (bool force=false)
 

Detailed Description

template<class charT, class traits = std::char_traits<charT>>
class RWTPortalStreamBase< charT, traits >

RWTPortalStreamBase includes functions common to derived portal stream classes.

Constructor & Destructor Documentation

◆ RWTPortalStreamBase() [1/2]

template<class charT , class traits = std::char_traits<charT>>
RWTPortalStreamBase< charT, traits >::RWTPortalStreamBase ( )

Constructs a portal stream.

◆ RWTPortalStreamBase() [2/2]

template<class charT , class traits = std::char_traits<charT>>
RWTPortalStreamBase< charT, traits >::RWTPortalStreamBase ( const RWPortal & )

Constructs a portal stream.

Member Function Documentation

◆ attach()

template<class charT , class traits = std::char_traits<charT>>
void RWTPortalStreamBase< charT, traits >::attach ( const RWPortal & p,
bool force = false )

Sets the stream to use a portal to the same communications channel as p. If force is true, the reattachment is forced, and any exceptions thrown by the underlying RWTPortalStreambuf are caught and ignored.

◆ detach()

template<class charT , class traits = std::char_traits<charT>>
void RWTPortalStreamBase< charT, traits >::detach ( bool force = false)

Detaches the stream from the portal channel. If force is true, the detach is forced, and any exceptions thrown by the underlying RWTPortalStreambuf are caught and ignored. If this is the last portal to this communications channel, then the channel is closed.

Copyright © 2024 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.