Socket (

This class implements a socket client to allow your programs to connect with socket servers. TCP and Local (Unix sockets) connections are implemented.

This class inherits Stream in gb.

This class is creatable.

Host   The host to which you would like to connect.
LocalHost   Once a TCP connection is established, this property reflects local IP used by this connection.
LocalPort   Once a TCP connection is established, this property reflects local port (1-65535) used by this connection.
Path   Return or set the path of the local socket you want to connect.
Port   The port to which you would like to connect on the remote host.
RemoteHost   Once a TCP connection is established, this property reflects remote IP used by this connection.
RemotePort   Once a TCP connection is established, this property reflects remote port (1-65535) used by this connection.
Server   If that socket has been created by the Accept method of a ServerSocket, then return that ServerSocket object.
Status   Reflects the current status of a Socket object.
StatusText   Return the status of the socket as a string.
Timeout   Return or set the timeout of the socket, in milliseconds.

Inherited properties
Blocking   Returns or sets if the stream is blocking.
ByteOrder   Returns or sets the byte order used to read or write binary data to the stream.
EndOfFile   This property signals whether the last use of LINE INPUT reached the end of file, instead of reading a full line with an end-of-line character.
EndOfLine   Return or set the newline separator used by this stream.
Eof   Return if a stream reached its end.
Handle   Returns the system file descriptor associated with this Stream.
IsTerm   Return if a stream is associated with a terminal.
Lines   Returns a virtual object that allows you to enumerate a stream line by line.
NullTerminatedString   Return or set if strings are null-terminated when they are serialized.
Tag   Returns or sets the tag associated with the stream.
Term   Return a virtual object that allows to manage the terminal associated with the stream.

Connect   Use this method to establish a TCP or Local (Unix) connection with a remote TCP or Local server.
Peek   This function allows you to receive data from Socket.

Inherited methods
Begin   Start to buffer data written to the stream, so that everything will be sent when the Send method is called.
Close   Closes the stream.
Drop   Drop the data that has been buffered since the last call to the Begin method.
ReadLine   Read a line of text from the stream, like the LINE INPUT instruction.
Send   Send all the data, in one shot, since the last call to Begin.
Watch   Start or stop watching the stream file descriptor for reading or writing, after it has been opened.

Closed   This event raises after the remote side of the socket has closed the connection.
Error   This event raises when some failed (for instance remote host refused connection).
Found   When connecting using TCP sockets, first step is to translate host name to host IP. The object will raise this event when this part of the connection process has been finished
Read   This event raises when data arrives to the socket from the other side of connection.
Ready   This event raises after a connection has been established successfully.
Write   This event is raised when the internal socket send buffers can take in more data.

This class performs its work asynchronously, so the program will not be stopped while connecting, sending or receiving data.

This class is derived from the class Stream, so you can use standard Stream & Input/Output functions to send and receive data, and to close the socket.

Sockets can be used if the library "" is included in the project. To include this library use the menu [Project] [Properties] [Components] and tick the component "".


' Gambas class file

PUBLIC MySock AS Socket

PUBLIC SUB Button1_Click()

  DIM sBuf AS String

  MySock = NEW Socket
  MySock.Connect("localhost", 7000)

  DO WHILE (MySock.Status <> Net.Connected) AND (MySock.Status > 0)
    WAIT 0.1

  IF MySock.Status <> Net.connected THEN
    PRINT "Error"

  sBuf = "Hello over there.\n"
  WRITE #MySock, sBuf, Len(sBuf)

  DO WHILE Lof(MySock) = 0
    WAIT 0.1
  READ #MySock, sBuf, Lof(MySock)
  PRINT sBuf

  CLOSE #MySock


Remarks on that example:
  • Even though polling is shown here, you should really use callbacks to react on different states.

  • See Network Programming, the tutorial about the usage of networking. There are comments to each line of this example.

  • There is another example in the distribution under Networking: ClientSocket.