SOCKET_STREAM_PARAMS Struct Reference

Public Attributes
unsigned int	ConnectedAddress
unsigned int	ConnectedPort
unsigned int	RcvBuf
unsigned int	SendBuf
signed int	TCPNoDelay
unsigned int	Timeout

Detailed Description

Structure that describes the socket options for the default socket connection method in the Server API and C++ client API. Note that this structure is used if the currently selected transfer plugin does NOT implement ConnectToServer (on the client) or AcceptConnection (on the server). If the plugin implements these functions, then it is up to the user of the API to determine what the appropriate mechanism for initializing the connection will be.

Member Data Documentation

unsigned int SOCKET_STREAM_PARAMS::ConnectedAddress

Once AcceptConnection() returns, this will contain the packet 32-bit IP address of the connected client.

unsigned int SOCKET_STREAM_PARAMS::ConnectedPort

Once AcceptConnection() returns, this will contain the internal socket used for routing of the server connection to this client. This is NOT the same as the port that AcceptConnection will listen on.

unsigned int SOCKET_STREAM_PARAMS::RcvBuf

The size in bytes of the recieve buffer for this socket.

unsigned int SOCKET_STREAM_PARAMS::SendBuf

The size in bytes of the send buffer for this socket.

signed int SOCKET_STREAM_PARAMS::TCPNoDelay

If H_FALSE, the TCPNoDelay flag will not be set on the socket. Otherwise, it will be set.

unsigned int SOCKET_STREAM_PARAMS::Timeout

The number of milliseconds before the connect function will time out and fail to connect. Note that this does not apply for AcceptConnection().