Simple communication stream with a remote socket

Introduced properties

init connect(host: String, port: Int)

socket :: TCPStream :: connect

Creates a socket connection to host host on port port
fun connected: Bool

socket :: TCPStream :: connected

Is this socket still connected?
init defaultinit(port: Int, host: String)

socket :: TCPStream :: defaultinit

fun flush

socket :: TCPStream :: flush

Send the data present in the socket buffer
fun host: String

socket :: TCPStream :: host

Real canonical name of the host to which self is connected
protected fun host=(host: String)

socket :: TCPStream :: host=

Real canonical name of the host to which self is connected
fun ready_to_read(timeout: Int): Bool

socket :: TCPStream :: ready_to_read

Easier use of pollin to check for something to read on all channels of any priority
fun write_ln(msg: Text)

socket :: TCPStream :: write_ln

Write msg, with a trailing \n

Redefined properties

redef type SELF: TCPStream

socket $ TCPStream :: SELF

Type of this instance, automatically specialized in every class
redef fun close

socket $ TCPStream :: close

close the stream
redef fun closed: Bool

socket $ TCPStream :: closed

Is this socket closed?
redef fun closed=(closed: Bool)

socket $ TCPStream :: closed=

Is this socket closed?
redef fun is_writable: Bool

socket $ TCPStream :: is_writable

Can the stream be used to write
redef fun poll_in: Bool

socket $ TCPStream :: poll_in

Is there something to read? (without blocking)
redef fun raw_read_byte: Int

socket $ TCPStream :: raw_read_byte

Read a byte directly from the underlying stream, without
redef fun raw_read_bytes(ns: CString, max: Int): Int

socket $ TCPStream :: raw_read_bytes

Read at most max bytes from the underlying stream into buf,
redef fun write(msg: Text)

socket $ TCPStream :: write

If socket.end_reached, nothing will happen
redef fun write_byte(value: Int)

socket $ TCPStream :: write_byte

Write a single byte
redef fun write_bytes_from_cstring(ns: CString, len: Int)

socket $ TCPStream :: write_bytes_from_cstring

Write len bytes from ns

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
fun address: String

socket :: TCPSocket :: address

IPv4 address to which self is connected
protected fun address=(address: String)

socket :: TCPSocket :: address=

IPv4 address to which self is connected
fun append_line_to(s: Buffer)

core :: Reader :: append_line_to

Read a string until the end of the line and append it to s.
fun big_endian: Bool

binary :: BinaryStream :: big_endian

Use the big-endian convention? otherwise use little-endian.
fun big_endian=(big_endian: Bool)

binary :: BinaryStream :: big_endian=

Use the big-endian convention? otherwise use little-endian.
fun blocking=(value: Bool)

socket :: Socket :: blocking=

Set whether calls to accept are blocking
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
abstract fun close

core :: Stream :: close

close the stream
fun closed: Bool

socket :: Socket :: closed

Is this socket closed?
protected fun closed=(closed: Bool)

socket :: Socket :: closed=

Is this socket closed?
fun codec: Codec

core :: Stream :: codec

Codec used to transform raw data to text
fun codec=(c: Codec)

core :: Stream :: codec=

Change the codec for this stream.
init connect(host: String, port: Int)

socket :: TCPStream :: connect

Creates a socket connection to host host on port port
fun connected: Bool

socket :: TCPStream :: connected

Is this socket still connected?
init defaultinit(port: Int, host: String)

socket :: TCPStream :: defaultinit

fun deserialize_msgpack(static_type: nullable String): nullable Object

core :: Reader :: deserialize_msgpack

Deserialize full Nit nullable Object from MessagePack formated data
fun each_line: LineIterator

core :: Reader :: each_line

Return an iterator that read each line.
fun eof: Bool

core :: Reader :: eof

Is there something to read.
fun finish

core :: Stream :: finish

Post-work hook.
fun flush

socket :: TCPStream :: flush

Send the data present in the socket buffer
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
fun host: String

socket :: TCPStream :: host

Real canonical name of the host to which self is connected
protected fun host=(host: String)

socket :: TCPStream :: host=

Real canonical name of the host to which self is connected
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
abstract fun is_writable: Bool

core :: Writer :: is_writable

Can the stream be used to write
fun last_error: nullable IOError

core :: Stream :: last_error

Error produced by the file stream
protected fun last_error=(last_error: nullable IOError)

core :: Stream :: last_error=

Error produced by the file stream
protected fun lookahead: CString

core :: Stream :: lookahead

Lookahead buffer for codecs
protected fun lookahead=(lookahead: CString)

core :: Stream :: lookahead=

Lookahead buffer for codecs
protected fun lookahead_capacity: Int

core :: Stream :: lookahead_capacity

Capacity of the lookahead
protected fun lookahead_capacity=(lookahead_capacity: Int)

core :: Stream :: lookahead_capacity=

Capacity of the lookahead
protected fun lookahead_length: Int

core :: Stream :: lookahead_length

Current occupation of the lookahead
protected fun lookahead_length=(lookahead_length: Int)

core :: Stream :: lookahead_length=

Current occupation of the lookahead
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
abstract fun poll_in: Bool

core :: PollableReader :: poll_in

Is there something to read? (without blocking)
fun port: Int

socket :: TCPSocket :: port

Port used by the socket
protected fun port=(port: Int)

socket :: TCPSocket :: port=

Port used by the socket
protected abstract fun raw_read_byte: Int

core :: Reader :: raw_read_byte

Read a byte directly from the underlying stream, without
protected fun raw_read_bytes(buf: CString, max: Int): Int

core :: Reader :: raw_read_bytes

Read at most max bytes from the underlying stream into buf,
fun read(i: Int): String

core :: Reader :: read

Reads a String of at most i length
fun read_all: String

core :: Reader :: read_all

Read all the stream until the eof.
fun read_all_bytes: Bytes

core :: Reader :: read_all_bytes

Read all the stream until the eof.
fun read_bits: Array[Bool]

core :: Reader :: read_bits

Get an Array of 8 Bool by reading a single byte
fun read_block: String

core :: Reader :: read_block

Read the length as a 64 bits integer, then the content of the block
fun read_bool: Bool

core :: Reader :: read_bool

Read a single byte and return true if its value is different than 0
fun read_byte: Int

core :: Reader :: read_byte

Reads a byte. Returns a negative value on error
fun read_bytes(max: Int): Bytes

core :: Reader :: read_bytes

Reads up to max bytes from source
fun read_bytes_to_cstring(bytes: CString, max: Int): Int

core :: Reader :: read_bytes_to_cstring

Reads up to max bytes from source and stores them in bytes
fun read_char: nullable Char

core :: Reader :: read_char

Reads a character. Returns null on EOF or timeout
fun read_double: Float

core :: Reader :: read_double

Read a floating point on 64 bits and return it as a Float
fun read_float: Float

core :: Reader :: read_float

Read a floating point on 32 bits and return it as a Float
fun read_int64: Int

core :: Reader :: read_int64

Read a signed integer on 64 bits and return is an Int
fun read_line: String

core :: Reader :: read_line

Read a string until the end of the line.
fun read_lines: Array[String]

core :: Reader :: read_lines

Read all the lines until the eof.
fun read_msgpack: nullable Serializable

core :: Reader :: read_msgpack

Read the next MessagePack object and return it as a simple Nit object
fun read_nonwhitespace: nullable Char

core :: Reader :: read_nonwhitespace

Skip whitespace characters (if any) then return the following non-whitespace character.
fun read_string: String

core :: Reader :: read_string

Read a null terminated string
fun read_word: String

core :: Reader :: read_word

Read the next sequence of non whitespace characters.
fun ready_to_read(timeout: Int): Bool

socket :: TCPStream :: ready_to_read

Easier use of pollin to check for something to read on all channels of any priority
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun serialize_msgpack(value: nullable Serializable, plain: nullable Bool)

core :: Writer :: serialize_msgpack

Serialize value in MessagePack format
protected fun set_codec(codec: Codec)

core :: Stream :: set_codec

Codec used to transform raw data to text
fun start

core :: Stream :: start

Pre-work hook.
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
abstract fun write(s: Text)

core :: Writer :: write

Write a string
fun write_bits(bits: Bool...)

core :: Writer :: write_bits

Write up to 8 Bool in a byte
fun write_block(text: Text)

core :: Writer :: write_block

Write the length as a 64 bits integer, then the content of text
fun write_bool(value: Bool)

core :: Writer :: write_bool

Write a boolean value on a byte, using 0 for false and 1 for true
protected fun write_buffer: CString

core :: Stream :: write_buffer

Buffer for writing data to a stream
protected fun write_buffer=(write_buffer: CString)

core :: Stream :: write_buffer=

Buffer for writing data to a stream
abstract fun write_byte(value: Int)

core :: Writer :: write_byte

Write a single byte
fun write_bytes(s: Bytes)

core :: Writer :: write_bytes

Write bytes from s
abstract fun write_bytes_from_cstring(ns: CString, len: Int)

core :: Writer :: write_bytes_from_cstring

Write len bytes from ns
fun write_char(c: Char)

core :: Writer :: write_char

Write a single char
fun write_double(value: Float)

core :: Writer :: write_double

Write a floating point value on 64 bits
fun write_float(value: Float)

core :: Writer :: write_float

Write a floating point value on 32 bits
fun write_int64(value: Int)

core :: Writer :: write_int64

Write value as a signed integer on 64 bits
fun write_ln(msg: Text)

socket :: TCPStream :: write_ln

Write msg, with a trailing \n
fun write_msgpack_array(len: Int)

core :: Writer :: write_msgpack_array

Write an array header for len items in the shortest possible MessagePack array format
fun write_msgpack_array16(len: Int)

core :: Writer :: write_msgpack_array16

Write an array header for len items, max of 0xFFFF items
fun write_msgpack_array32(len: Int)

core :: Writer :: write_msgpack_array32

Write an array header for len items, max of 0xFFFF_FFFF items
fun write_msgpack_bin(data: Bytes)

core :: Writer :: write_msgpack_bin

Write data in the shortest possible MessagePack bin format
fun write_msgpack_bin16(data: Bytes)

core :: Writer :: write_msgpack_bin16

Write data in bin16 format, max of 0xFFFF bytes
fun write_msgpack_bin32(data: Bytes)

core :: Writer :: write_msgpack_bin32

Write data in bin32 format, max of 0xFFFF_FFFF bytes
fun write_msgpack_bin8(data: Bytes)

core :: Writer :: write_msgpack_bin8

Write data in bin8 format, max of 0xFF bytes
fun write_msgpack_bool(bool: Bool)

core :: Writer :: write_msgpack_bool

Write bool in MessagePack format
fun write_msgpack_double(value: Float)

core :: Writer :: write_msgpack_double

Write value as a MessagePack double
fun write_msgpack_ext(typ: Int, bytes: Bytes)

core :: Writer :: write_msgpack_ext

Write an application-specific extension for typ and bytes in the shortest possible MessagePack ext format
fun write_msgpack_ext16(typ: Int, len: Int)

core :: Writer :: write_msgpack_ext16

Write the header for an application-specific extension of len data bytes
fun write_msgpack_ext32(typ: Int, len: Int)

core :: Writer :: write_msgpack_ext32

Write the header for an application-specific extension of len data bytes
fun write_msgpack_ext8(typ: Int, len: Int)

core :: Writer :: write_msgpack_ext8

Write the header for an application-specific extension of len data bytes
fun write_msgpack_fixarray(len: Int)

core :: Writer :: write_msgpack_fixarray

Write an array header for len items, max of 0x0F items
fun write_msgpack_fixext1(typ: Int)

core :: Writer :: write_msgpack_fixext1

Write the header for an application-specific extension of one data byte
fun write_msgpack_fixext16(typ: Int)

core :: Writer :: write_msgpack_fixext16

Write the header for an application-specific extension of 16 data bytes
fun write_msgpack_fixext2(typ: Int)

core :: Writer :: write_msgpack_fixext2

Write the header for an application-specific extension of two data bytes
fun write_msgpack_fixext4(typ: Int)

core :: Writer :: write_msgpack_fixext4

Write the header for an application-specific extension of 4 data bytes
fun write_msgpack_fixext8(typ: Int)

core :: Writer :: write_msgpack_fixext8

Write the header for an application-specific extension of 8 data bytes
fun write_msgpack_fixint(value: Int)

core :: Writer :: write_msgpack_fixint

Write value as a single byte with metadata
fun write_msgpack_fixmap(len: Int)

core :: Writer :: write_msgpack_fixmap

Write a map header for len key/value pairs, max of 0x0F pairs
fun write_msgpack_fixstr(text: Text)

core :: Writer :: write_msgpack_fixstr

Write text in fixstr format, max of 0x1F bytes
fun write_msgpack_float(value: Float)

core :: Writer :: write_msgpack_float

Write value as a MessagePack float (losing precision)
fun write_msgpack_int(value: Int)

core :: Writer :: write_msgpack_int

Write the integer value either as the shortest possible MessagePack int
fun write_msgpack_int16(value: Int)

core :: Writer :: write_msgpack_int16

Write value over two signed bytes, following 1 metadata byte
fun write_msgpack_int32(value: Int)

core :: Writer :: write_msgpack_int32

Write value over 4 signed bytes, following 1 metadata byte
fun write_msgpack_int64(value: Int)

core :: Writer :: write_msgpack_int64

Write value over 8 signed bytes, following 1 metadata byte
fun write_msgpack_int8(value: Int)

core :: Writer :: write_msgpack_int8

Write value over one signed byte, following 1 metadata byte
fun write_msgpack_map(len: Int)

core :: Writer :: write_msgpack_map

Write a map header for len keys/value pairs in the shortest possible MessagePack map format
fun write_msgpack_map16(len: Int)

core :: Writer :: write_msgpack_map16

Write a map header for len key/value pairs, max of 0xFFFF pairs
fun write_msgpack_map32(len: Int)

core :: Writer :: write_msgpack_map32

Write a map header for len key/value pairs, max of 0xFFFF_FFFF pairs
fun write_msgpack_null

core :: Writer :: write_msgpack_null

Write null, or nil, in MessagePack format
fun write_msgpack_str(text: Text)

core :: Writer :: write_msgpack_str

Write text in the shortest possible MessagePack format
fun write_msgpack_str16(text: Text)

core :: Writer :: write_msgpack_str16

Write text in str16 format, max of 0xFFFF bytes
fun write_msgpack_str32(text: Text)

core :: Writer :: write_msgpack_str32

Write text in str32 format, max of 0xFFFF_FFFF bytes
fun write_msgpack_str8(text: Text)

core :: Writer :: write_msgpack_str8

Write text in str8 format, max of 0xFF bytes
fun write_msgpack_uint16(value: Int)

core :: Writer :: write_msgpack_uint16

Write value over two unsigned bytes, following 1 metadata byte
fun write_msgpack_uint32(value: Int)

core :: Writer :: write_msgpack_uint32

Write value over 4 unsigned bytes, following 1 metadata byte
fun write_msgpack_uint64(value: Int)

core :: Writer :: write_msgpack_uint64

Write value over 8 unsigned bytes, following 1 metadata byte
fun write_msgpack_uint8(value: Int)

core :: Writer :: write_msgpack_uint8

Write value over one unsigned byte, following 1 metadata byte
fun write_string(text: Text)

core :: Writer :: write_string

Write text as a null terminated string
package_diagram socket::TCPStream TCPStream socket::TCPSocket TCPSocket socket::TCPStream->socket::TCPSocket core::PollableReader PollableReader socket::TCPStream->core::PollableReader core::Duplex Duplex socket::TCPStream->core::Duplex socket::Socket Socket socket::TCPSocket->socket::Socket core::Reader Reader core::PollableReader->core::Reader core::Duplex->core::Reader core::Writer Writer core::Duplex->core::Writer ...socket::Socket ... ...socket::Socket->socket::Socket ...core::Reader ... ...core::Reader->core::Reader ...core::Writer ... ...core::Writer->core::Writer

Ancestors

abstract class BinaryStream

binary :: BinaryStream

A stream of binary data
interface Object

core :: Object

The root of the class hierarchy.
abstract class Reader

core :: Reader

A Stream that can be read from
abstract class Socket

socket :: Socket

A general Socket, either TCP or UDP
abstract class Stream

core :: Stream

Any kind of stream to read/write/both to or from a source
abstract class Writer

core :: Writer

A Stream that can be written to

Parents

abstract class Duplex

core :: Duplex

A Stream that can be written to and read from
abstract class PollableReader

core :: PollableReader

Reader capable of declaring if readable without blocking
abstract class TCPSocket

socket :: TCPSocket

A general TCP socket, either a TCPStream or a TCPServer

Class definitions

socket $ TCPStream
# Simple communication stream with a remote socket
class TCPStream
	super TCPSocket
	super PollableReader
	super Duplex

	# Real canonical name of the host to which `self` is connected
	var host: String

	private var addrin: NativeSocketAddrIn is noinit

	redef var closed = false

	# TODO make init private

	# Creates a socket connection to host `host` on port `port`
	init connect(host: String, port: Int)
	do
		native = new NativeSocket.socket(new NativeSocketAddressFamilies.af_inet,
			new NativeSocketTypes.sock_stream, new NativeSocketProtocolFamilies.pf_unspec)
		if native.address_is_null then
			closed = true
			return
		end
		if not native.setsockopt(new NativeSocketOptLevels.socket, new NativeSocketOptNames.reuseaddr, 1) then
			closed = true
			return
		end

		var hostent = sys.gethostbyname(host.to_cstring)
		if hostent.address_is_null then
			# Error in name lookup
			last_error = new IOError.from_h_errno

			closed = true

			return
		end

		addrin = new NativeSocketAddrIn
		addrin.fill_from_hostent hostent
		addrin.port = port

		address = addrin.address.to_s
		init(addrin.port, hostent.h_name.to_s)

		closed = not internal_connect
		if closed then
			# Connection failed
			last_error = new IOError.from_errno
		end
	end

	# Creates a client socket, this is meant to be used by accept only
	private init server_side(h: SocketAcceptResult)
	do
		native = h.socket
		addrin = h.addr_in
		address = addrin.address.to_s

		init(addrin.port, address)
	end

	redef fun poll_in do return ready_to_read(0)

	# Returns an array containing an enum of the events ready to be read
	#
	# event_types : Combination of several event types to watch
	#
	# timeout : Time in milliseconds before stopping listening for events on this socket
	private fun pollin(event_types: Array[NativeSocketPollValues], timeout: Int): Array[NativeSocketPollValues] do
		if closed then return new Array[NativeSocketPollValues]
		return native.socket_poll(new PollFD.from_poll_values(native.descriptor, event_types), timeout)
	end

	# Easier use of pollin to check for something to read on all channels of any priority
	#
	# timeout : Time in milliseconds before stopping to wait for events
	fun ready_to_read(timeout: Int): Bool
	do
		var events = [new NativeSocketPollValues.pollin]
		return pollin(events, timeout).length != 0
	end

	# Is this socket still connected?
	fun connected: Bool
	do
		if closed then return false
		if native.poll_hup_err == 0 then
			return true
		else
			closed = true
			return false
		end
	end

	redef fun is_writable do return not closed

	# Establishes a connection to socket addrin
	#
	# REQUIRES : not self.end_reached
	private fun internal_connect: Bool
	do
		assert not closed
		return native.connect(addrin) >= 0
	end

	redef fun raw_read_byte do
		var rd = native.read(write_buffer, 1)
		if rd < 1 then return -1
		return write_buffer[0].to_i
	end

	redef fun raw_read_bytes(ns, max) do
		var rd = native.read(ns, max)
		print "Read {rd} bytes"
		if rd < 0 then return -1
		return rd
	end

	# If socket.end_reached, nothing will happen
	redef fun write(msg)
	do
		if closed then return
		native.write(msg.to_cstring, msg.length)
	end

	redef fun write_byte(value)
	do
		if closed then return
		native.write_byte value
	end

	redef fun write_bytes_from_cstring(ns, len) do
		if closed then return
		native.write(ns, len)
	end

	# Write `msg`, with a trailing `\n`
	fun write_ln(msg: Text)
	do
		if closed then return
		write msg.to_s
		write "\n"
	end

	redef fun close
	do
		if closed then return
		if native.close >= 0 then
			closed = true
		end
	end

	# Send the data present in the socket buffer
	fun flush
	do
		if not native.setsockopt(new NativeSocketOptLevels.tcp, new NativeSocketOptNames.tcp_nodelay, 1) or
		   not native.setsockopt(new NativeSocketOptLevels.tcp, new NativeSocketOptNames.tcp_nodelay, 0) then
			closed = true
		end
	end
end
lib/socket/socket.nit:55,1--217,3