Back to product page

SocksConnect method


Called when a user wants to open an outgoing connection through a socks server.

Type

None

Syntax

  • Basic
object.SocksConnect       Owner, Chan, User, RemoteAddress, RemotePort, Login, Password, Allow
The SocksConnect(object,Owner,Chan,User,RemoteAddress,RemotePort,Login,Password,Allow) syntax has these parts:
objectAn expression evaluating to an object of type wodTunnelNotify.
OwnerRequired. A wodTunnelCom object. Reference to the wodTunnelCom instance that called this notification method.
ChanA Channel object. Reference to the channel where the user connected.
UserAn User object. Reference to the user that wants to connect through a socks proxy.
RemoteAddressA String value. Hostname or IP address that the user wants to connect to.
RemotePortA Long value. Port on the remote host that the user wants to connect to.
LoginA String value. Login/Username supplied by the user to access wodSSHTunnel's socks features.
PasswordA String value. Password supplied by the user to access wodSSHTunnel's socks features.
AllowA Boolean value. When set to False, wodSSHTunnel aborts the socks request.

Remarks

This method is called only if you have implemented the IwodSSHTunnelNotify interface in your application and the wodTunnel1.Notification property has received a reference to an instance of your implementation.

The SocksConnect notification method is called only if you have created the channel specifying the SocksProxy setting in the Channel.Type property and a user wants to connect to a remote hostname through your proxy. When the notification is called, you will get information about this socks request that you should evaluate and set the Allow argument accordingly.

This notification informs you that a request has been made - this does not necessarily mean that a connection will be established (it may still fail with an error), but in this case the appropriate notification will be called (such as the UserDisconnected notification method).

Platforms

Windows