Index · Object → RefCounted → StreamPeer → StreamPeerSocket → StreamPeerTCP

StreamPeerTCP

A stream peer that handles TCP connections.

Class Description

A stream peer that handles TCP connections. This object can be used to connect to TCP servers, or also is returned by a TCP server.

Note: When exporting to Android, make sure to enable the INTERNET permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.

Properties

Inherited from StreamPeer (1)
var big_endian: bool = false

Methods

func bind(port: int, host: String = "*") -> Error

Opens the TCP socket, and binds it to the specified local address.

This method is generally not needed, and only used to force the subsequent call to connect_to_host() to use the specified host and port as source address. This can be desired in some NAT punchthrough techniques, or when forcing the source network interface.

func connect_to_host(host: String, port: int) -> Error

Connects to the specified host:port pair. A hostname will be resolved if valid. Returns OK on success.

func get_connected_host() -> String

Returns the IP of this peer.

func get_connected_port() -> int

Returns the port of this peer.

func get_local_port() -> int

Returns the local port to which this peer is bound.

func set_no_delay(enabled: bool) -> void

If enabled is true, packets will be sent immediately. If enabled is false (the default), packet transfers will be delayed and combined using Nagle's algorithm.

Note: It's recommended to leave this disabled for applications that send large packets or need to transfer a lot of data, as enabling this can decrease the total available bandwidth.

Inherited from StreamPeerSocket (3)
func disconnect_from_host() -> void
func poll() -> Error
Inherited from StreamPeer (33)
func get_8() -> int
func get_16() -> int
func get_32() -> int
func get_64() -> int
func get_data(bytes: int) -> Array
func get_double() -> float
func get_float() -> float
func get_half() -> float
func get_partial_data(bytes: int) -> Array
func get_string(bytes: int = -1) -> String
func get_u8() -> int
func get_u16() -> int
func get_u32() -> int
func get_u64() -> int
func get_utf8_string(bytes: int = -1) -> String
func get_var(allow_objects: bool = false) -> Variant
func put_8(value: int) -> void
func put_16(value: int) -> void
func put_32(value: int) -> void
func put_64(value: int) -> void
func put_data(data: PackedByteArray) -> Error
func put_double(value: float) -> void
func put_float(value: float) -> void
func put_half(value: float) -> void
func put_string(value: String) -> void
func put_u8(value: int) -> void
func put_u16(value: int) -> void
func put_u32(value: int) -> void
func put_u64(value: int) -> void
func put_utf8_string(value: String) -> void
func put_var(value: Variant, full_objects: bool = false) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Object (2)