UDK 3.2.7 C/C++ API Reference
Public Member Functions
osl::ConnectorSocket Class Reference

#include <socket_decl.hxx>

Inheritance diagram for osl::ConnectorSocket:
osl::StreamSocket osl::Socket

List of all members.

Public Member Functions

 ConnectorSocket (oslAddrFamily Family=osl_Socket_FamilyInet, oslProtocol Protocol=osl_Socket_ProtocolIp, oslSocketType Type=osl_Socket_TypeStream)
 Creates a socket that can connect to a (remote) host.
oslSocketResult connect (const SocketAddr &TargetHost, const TimeValue *pTimeout=0)
 Connects the socket to a (remote) host.

Constructor & Destructor Documentation

osl::ConnectorSocket::ConnectorSocket ( oslAddrFamily  Family = osl_Socket_FamilyInet,
oslProtocol  Protocol = osl_Socket_ProtocolIp,
oslSocketType  Type = osl_Socket_TypeStream 
) [inline]

Creates a socket that can connect to a (remote) host.

Parameters:
TypeFor some protocols it might be desirable to use a different type than sock_stream osl_Socket_TypeSeqPacket (like osl_Socket_TypeSeqPacket). Therefore we do not hide this parameter here.

Member Function Documentation

oslSocketResult osl::ConnectorSocket::connect ( const SocketAddr TargetHost,
const TimeValue pTimeout = 0 
) [inline]

Connects the socket to a (remote) host.

Parameters:
TargetHostThe address of the target.
pTimeoutThe timeout for blocking. If 0, a default system dependent timeout us used.
Returns:
osl_Socket_Ok if connected successfully, osl_Socket_TimedOut on timeout, osl_Socket_Interrupted if unblocked forcefully (by osl::Socket::close()), osl_Socket_Error if connect failed.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines