ICreateStreamSocketConnections Class Reference
[Stream Sockets, Connection managers, Interfaces, Protected destructors on abstract base classes]
Detailed Description
An interface used to create outgoing stream socket connections.Public Member Functions | |
| virtual CSmartStreamSocket | Connect (const IFullAddress &address, const void *pUserData=nullptr, SocketBufferSize recvBufferSize=DefaultSocketBufferSize, SocketBufferSize sendBufferSize=DefaultSocketBufferSize)=0 |
| Connects, synchronously, to the specified address and returns a smart pointer to the resulting stream socket. Throws exceptions on failure to connect, the resulting stream socket is always connected and valid. Passes the user data pointer through to IStreamSocketConnectionManagerCallback::OnPreOutgoingConnect() before returning. Sets send and recv buffer sizes before connection if values other than 0 are supplied; note that this WILL affect the TCP window size. Calls IStreamSocketConnectionManagerCallback::OnConnectionEstablished(), before returning, if the connection is successful. | |
| virtual CSmartStreamSocket | ConnectNoThrow (const IFullAddress &address, const void *pUserData=nullptr, SocketBufferSize recvBufferSize=DefaultSocketBufferSize, SocketBufferSize sendBufferSize=DefaultSocketBufferSize)=0 |
| Connects, synchronously, to the specified address and returns a smart pointer to the resulting stream socket. Does not throw exceptions, the smart stream pointer will be null if the connection attempt fails; call CSmartStreamSocket::Get() to determine this. Passes the user data pointer through to IStreamSocketConnectionManagerCallback::OnPreOutgoingConnect() before returning. Sets send and recv buffer sizes before connection if values other than 0 are supplied; note that this WILL affect the TCP window size. Calls IStreamSocketConnectionManagerCallback::OnOutgoingConnectionFailed(), before returning, if the connection fails and IStreamSocketConnectionManagerCallback::OnConnectionEstablished(), before returning, if the connection is successful. | |
| virtual CSmartStreamSocket | AsyncConnect (const IFullAddress &address, const void *pUserData=nullptr, SocketBufferSize recvBufferSize=DefaultSocketBufferSize, SocketBufferSize sendBufferSize=DefaultSocketBufferSize)=0 |
| Connects, asynchronously, to the specified address and returns a smart pointer to the resulting stream socket. Throws exceptions on some failures to connect. The smart stream pointer is not connected until the IStreamSocketConnectionManagerCallback::OnConnectionEstablished() has been called and this may be before or after the function returns to the caller. Sets send and recv buffer sizes before connection if values other than 0 are supplied; note that this WILL affect the TCP window size. Passes the user data pointer through to IStreamSocketConnectionManagerCallback::OnPreOutgoingConnect() before returning. Calls IStreamSocketConnectionManagerCallback::OnOutgoingConnectionFailed(), either before or after returning, if the connection fails and IStreamSocketConnectionManagerCallback::OnConnectionEstablished(), either before or after returning, if the connection is successful. | |
| virtual CSmartStreamSocket | AsyncConnectNoThrow (const IFullAddress &address, const void *pUserData=nullptr, SocketBufferSize recvBufferSize=DefaultSocketBufferSize, SocketBufferSize sendBufferSize=DefaultSocketBufferSize)=0 |
| Connects, asynchronously, to the specified address and returns a smart pointer to the resulting stream socket. Does not throw exceptions, the smart stream pointer will be null if the connection attempt fails; call CSmartStreamSocket::Get() to determine this. Passes the user data pointer through to IStreamSocketConnectionManagerCallback::OnPreOutgoingConnect() before returning. Sets send and recv buffer sizes before connection if values other than 0 are supplied; note that this WILL affect the TCP window size. Calls IStreamSocketConnectionManagerCallback::OnOutgoingConnectionFailed(), either before or after returning, if the connection fails and IStreamSocketConnectionManagerCallback::OnConnectionEstablished(), either before or after returning, if the connection is successful. | |
| virtual CSmartStreamSocket | ConnectAsyncIfAvailable (const IFullAddress &address, const void *pUserData=nullptr, SocketBufferSize recvBufferSize=DefaultSocketBufferSize, SocketBufferSize sendBufferSize=DefaultSocketBufferSize)=0 |
| If the platform supports asynchronous connections for this address type then acts as an AsyncConnect() else acts as a ConnectNoThrow(). | |
| virtual CSmartStreamSocket | ConnectAsyncIfAvailableNoThrow (const IFullAddress &address, const void *pUserData=nullptr, SocketBufferSize recvBufferSize=DefaultSocketBufferSize, SocketBufferSize sendBufferSize=DefaultSocketBufferSize)=0 |
| If the platform supports asynchronous connections for this address type then acts as an AsyncConnectNoThrow() else acts as a ConnectNoThrow(). | |
| virtual bool | AsyncConnectAvailable (const IAddressType &addressType) const =0 |
| Returns true if the platform supports asynchronous connections for this address type. | |
| virtual DWORD | AbortAllConnections ()=0 |
| Aborts all connections that are managed by this connection manager. | |
Protected Member Functions | |
| virtual | ~ICreateStreamSocketConnections () |
| We never delete instances of this interface; you must manage the lifetime of the class that implements it. | |
Constructor & Destructor Documentation
| virtual ~ICreateStreamSocketConnections | ( | ) | [protected, virtual] |
We never delete instances of this interface; you must manage the lifetime of the class that implements it.
Member Function Documentation
| virtual CSmartStreamSocket Connect | ( | const IFullAddress & | address, | |
| const void * | pUserData = nullptr, |
|||
| SocketBufferSize | recvBufferSize = DefaultSocketBufferSize, |
|||
| SocketBufferSize | sendBufferSize = DefaultSocketBufferSize | |||
| ) | [pure virtual] |
Connects, synchronously, to the specified address and returns a smart pointer to the resulting stream socket. Throws exceptions on failure to connect, the resulting stream socket is always connected and valid. Passes the user data pointer through to IStreamSocketConnectionManagerCallback::OnPreOutgoingConnect() before returning. Sets send and recv buffer sizes before connection if values other than 0 are supplied; note that this WILL affect the TCP window size. Calls IStreamSocketConnectionManagerCallback::OnConnectionEstablished(), before returning, if the connection is successful.
Implemented in CConnectionMaintainingStreamSocketConnectionFilter.
| virtual CSmartStreamSocket ConnectNoThrow | ( | const IFullAddress & | address, | |
| const void * | pUserData = nullptr, |
|||
| SocketBufferSize | recvBufferSize = DefaultSocketBufferSize, |
|||
| SocketBufferSize | sendBufferSize = DefaultSocketBufferSize | |||
| ) | [pure virtual] |
Connects, synchronously, to the specified address and returns a smart pointer to the resulting stream socket. Does not throw exceptions, the smart stream pointer will be null if the connection attempt fails; call CSmartStreamSocket::Get() to determine this. Passes the user data pointer through to IStreamSocketConnectionManagerCallback::OnPreOutgoingConnect() before returning. Sets send and recv buffer sizes before connection if values other than 0 are supplied; note that this WILL affect the TCP window size. Calls IStreamSocketConnectionManagerCallback::OnOutgoingConnectionFailed(), before returning, if the connection fails and IStreamSocketConnectionManagerCallback::OnConnectionEstablished(), before returning, if the connection is successful.
Implemented in CConnectionMaintainingStreamSocketConnectionFilter.
| virtual CSmartStreamSocket AsyncConnect | ( | const IFullAddress & | address, | |
| const void * | pUserData = nullptr, |
|||
| SocketBufferSize | recvBufferSize = DefaultSocketBufferSize, |
|||
| SocketBufferSize | sendBufferSize = DefaultSocketBufferSize | |||
| ) | [pure virtual] |
Connects, asynchronously, to the specified address and returns a smart pointer to the resulting stream socket. Throws exceptions on some failures to connect. The smart stream pointer is not connected until the IStreamSocketConnectionManagerCallback::OnConnectionEstablished() has been called and this may be before or after the function returns to the caller. Sets send and recv buffer sizes before connection if values other than 0 are supplied; note that this WILL affect the TCP window size. Passes the user data pointer through to IStreamSocketConnectionManagerCallback::OnPreOutgoingConnect() before returning. Calls IStreamSocketConnectionManagerCallback::OnOutgoingConnectionFailed(), either before or after returning, if the connection fails and IStreamSocketConnectionManagerCallback::OnConnectionEstablished(), either before or after returning, if the connection is successful.
Implemented in CConnectionMaintainingStreamSocketConnectionFilter.
| virtual CSmartStreamSocket AsyncConnectNoThrow | ( | const IFullAddress & | address, | |
| const void * | pUserData = nullptr, |
|||
| SocketBufferSize | recvBufferSize = DefaultSocketBufferSize, |
|||
| SocketBufferSize | sendBufferSize = DefaultSocketBufferSize | |||
| ) | [pure virtual] |
Connects, asynchronously, to the specified address and returns a smart pointer to the resulting stream socket. Does not throw exceptions, the smart stream pointer will be null if the connection attempt fails; call CSmartStreamSocket::Get() to determine this. Passes the user data pointer through to IStreamSocketConnectionManagerCallback::OnPreOutgoingConnect() before returning. Sets send and recv buffer sizes before connection if values other than 0 are supplied; note that this WILL affect the TCP window size. Calls IStreamSocketConnectionManagerCallback::OnOutgoingConnectionFailed(), either before or after returning, if the connection fails and IStreamSocketConnectionManagerCallback::OnConnectionEstablished(), either before or after returning, if the connection is successful.
Implemented in CConnectionMaintainingStreamSocketConnectionFilter.
| virtual CSmartStreamSocket ConnectAsyncIfAvailable | ( | const IFullAddress & | address, | |
| const void * | pUserData = nullptr, |
|||
| SocketBufferSize | recvBufferSize = DefaultSocketBufferSize, |
|||
| SocketBufferSize | sendBufferSize = DefaultSocketBufferSize | |||
| ) | [pure virtual] |
If the platform supports asynchronous connections for this address type then acts as an AsyncConnect() else acts as a ConnectNoThrow().
Implemented in CConnectionMaintainingStreamSocketConnectionFilter.
| virtual CSmartStreamSocket ConnectAsyncIfAvailableNoThrow | ( | const IFullAddress & | address, | |
| const void * | pUserData = nullptr, |
|||
| SocketBufferSize | recvBufferSize = DefaultSocketBufferSize, |
|||
| SocketBufferSize | sendBufferSize = DefaultSocketBufferSize | |||
| ) | [pure virtual] |
If the platform supports asynchronous connections for this address type then acts as an AsyncConnectNoThrow() else acts as a ConnectNoThrow().
Implemented in CConnectionMaintainingStreamSocketConnectionFilter.
| virtual bool AsyncConnectAvailable | ( | const IAddressType & | addressType | ) | const [pure virtual] |
Returns true if the platform supports asynchronous connections for this address type.
Implemented in CConnectionMaintainingStreamSocketConnectionFilter.
| virtual DWORD AbortAllConnections | ( | ) | [pure virtual] |
Aborts all connections that are managed by this connection manager.
Implemented in CConnectionMaintainingStreamSocketConnectionFilter, TConnectionManagerBase< JetByteTools::Socket::CFilteringStreamSocketConnectionManagerBase, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketConnectionManagerIO, JetByteTools::Socket::IStreamSocketConnectionManagerCallback, JetByteTools::Socket::IAllocateStreamSockets >, and TConnectionManagerBase< Base, JetByteTools::Socket::IStreamSocketConnectionManager, JetByteTools::Socket::IStreamSocketConnectionManagerIO, JetByteTools::Socket::IStreamSocketConnectionManagerCallback, JetByteTools::Socket::IAllocateStreamSockets >.
