Gambas Documentation
Application Repository
Code Snippets
Compilation & Installation
Components
gb
gb.args
gb.cairo
gb.chart
gb.clipper
gb.complex
gb.compress
gb.crypt
gb.data
gb.db
gb.db.form
gb.db.mysql
gb.db.odbc
gb.db.postgresql
gb.db.sqlite2
gb.db.sqlite3
gb.dbus
gb.dbus.trayicon
gb.debug
gb.desktop
gb.desktop.gnome.keyring
gb.desktop.x11
gb.eval
gb.eval.highlight
gb.form
gb.form.dialog
gb.form.editor
gb.form.htmlview
gb.form.mdi
gb.form.print
gb.form.stock
gb.form.terminal
gb.gmp
gb.gsl
gb.gtk
gb.gtk.opengl
gb.gtk3
gb.gtk3.opengl
gb.gtk3.webview
gb.gui
gb.gui.opengl
gb.gui.qt
gb.gui.qt.opengl
gb.gui.qt.webkit
gb.gui.trayicon
gb.gui.webview
gb.hash
gb.highlight
gb.image
gb.image.effect
gb.image.imlib
gb.image.io
gb.inotify
gb.jit
gb.libxml
gb.logging
gb.map
gb.markdown
gb.media
gb.media.form
gb.memcached
gb.mime
gb.mysql
gb.ncurses
gb.net
.UdpSocket.Multicast
DnsClient
Net
SerialPort
ServerSocket
Socket
UdpSocket
_new
Bind
Broadcast
Error
Host
Multicast
Path
Peek
Port
Read
SourceHost
SourcePath
SourcePort
Status
TargetHost
TargetPath
TargetPort
Timeout
gb.net.curl
gb.net.pop3
gb.net.smtp
gb.openal
gb.opengl
gb.opengl.glsl
gb.opengl.glu
gb.opengl.sge
gb.openssl
gb.option
gb.pcre
gb.pdf
gb.poppler
gb.qt4
gb.qt4.ext
gb.qt4.opengl
gb.qt4.webkit
gb.qt4.webview
gb.qt5
gb.qt5.ext
gb.qt5.opengl
gb.qt5.webkit
gb.qt5.webview
gb.report
gb.report2
gb.scanner
gb.sdl
gb.sdl.sound
gb.sdl2
gb.sdl2.audio
gb.settings
gb.signal
gb.term
gb.test
gb.util
gb.util.web
gb.v4l
gb.vb
gb.web
gb.web.feed
gb.web.form
gb.web.gui
gb.xml
gb.xml.html
gb.xml.rpc
gb.xml.xslt
Controls pictures
Deprecated components
Developer Documentation
Development Environment Documentation
Documents
Error Messages
Gambas Playground
How To's
Language Index
Language Overviews
Last Changes
Lexicon
README
Search the wiki
To Do
Topics
Tutorials
Wiki License
Wiki Manual

UdpSocket (gb.net)

This class allows Gambas programs to communicate using UDP sockets.

It can be used like a server or client, as each data fragment sent or received is identified with its host IP and port.

This class inherits from Stream class, so you can use standard stream methods to read, write and close the socket.

This class inherits Stream in gb.

This class is creatable.

Properties
Broadcast   Return or set if the UpdSocket will broadcast its packets.
Host   Return or set the IP address the UDP socket will be bound to.
Multicast   This property returns a virtual object that allows to use the UDP socket for doing multicast.
Path   Return or set the udp socket path for local sockets.
Port   Return or set the port number used for binding the UDP socket.
SourceHost   Return the source IP address if the message comes from the internet.
SourcePath   Return the source path if the message comes from a local socket.
SourcePort   Return the source port if the message comes from the internet.
Status   Returns the status of the socket, as a constant of the Net class.
StatusText  
TargetHost   Define the target IP address if the message goes to the internet.
TargetPath   Define the target path if the message goes to a local socket.
TargetPort   Define the target port if the message goes to the internet.
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.
NoShare  
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.

Methods
Bind   Bind a socket so the object can start sending and receiving data.
Peek   This method is used to peek information from remote host(s).

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.

Events
Error   This event raises when some failed (for instance socket binding failed). Status property will turn to a value lesser than zero, and socket will be automatically closed.
Read   This event raises when some data arrives to the socket from a remote host.