RWSocketPortal

Module:  Essential Networking Module   Package:  Networking

            RWPortal
RWSocketPortal
               RWSocketPortalBase

• Local Index
• Header File
• Description
• Public Enum
• Public Constructors
• Public Member Functions

Members

connect()

getSocket()

RWSocketPortal()

WhoShouldClose

#include <rw/network/RWSocketPortal.h>

RWSocketPortal is a socket implementation of a portal, implemented using the RWSocket class. State is not added to RWPortal. This means that you can assign an RWSocketPortal to an RWPortal without loss of data, except for the type.

The RWSocket representing RWSocketPortal's communication channel is normally closed when the last portal into the channel is destroyed. It is possible to prevent this by using a special constructor.

enum WhoShouldClose { Portal, Application };

Indicates who should close the socket.

RWSocketPortal();

Creates a socket portal. You need to establish a connection using connect() or the assignment operator before the portal can be used.

RWSocketPortal(const RWSockAddrBase&);

Creates a socket portal connected to the address provided.

RWSocketPortal(const RWSocket& socket, 
               WhoShouldClose=Portal);

Creates a portal to the communications channel represented by socket. Using this constructor is the only way to create a socket that is not automatically closed when portals are no longer using it.

void 
connect(const RWSockAddrBase& address);

Connects this portal to the address provided.

RWSocket 
getSocket() const;

Returns a copy of the underlying RWSocket object.

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.