RawDatagramSocket abstract class

The RawDatagramSocket is a low-level interface to an UDP socket, exposing the raw events signaled by the system. It's a Stream of RawSocketEvents.

Note that the event RawSocketEvent.READ_CLOSED will never be received as an UDP socket cannot be closed by a remote peer.

Inheritance

Static Methods

bind(host, int port, { bool reuseAddress: true }) → Future<RawDatagramSocket>

Creates a new raw datagram socket binding it to an address and port.

Constructors

RawDatagramSocket()

Properties

addressInternetAddress
read-only

Returns the address used by this socket.

broadcastEnabledbool
read / write

Set or get, whether IPv4 broadcast is enabled.

multicastHopsint
read / write

Set or get, the maximum network hops for multicast packages originating from this socket.

multicastInterfaceNetworkInterface
read / write

Set or get, the network interface used for outgoing multicast packages.

multicastLoopbackbool
read / write

Set or get, whether multicast traffic is looped back to the host.

portint
read-only

Returns the port used by this socket.

readEventsEnabledbool
read / write

Set or get, if the RawDatagramSocket should listen for RawSocketEvent.READ events. Default is true.

writeEventsEnabledbool
read / write

Set or get, if the RawDatagramSocket should listen for RawSocketEvent.WRITE events. Default is true. This is a one-shot listener, and writeEventsEnabled must be set to true again to receive another write event.

firstFuture<RawSocketEvent>
read-only, inherited

Returns the first element of the stream.

hashCodeint
read-only, inherited

The hash code for this object.

isBroadcastbool
read-only, inherited

Whether this stream is a broadcast stream.

isEmptyFuture<bool>
read-only, inherited

Reports whether this stream contains any elements.

lastFuture<RawSocketEvent>
read-only, inherited

Returns the last element of the stream.

lengthFuture<int>
read-only, inherited

Counts the elements in the stream.

runtimeTypeType
read-only, inherited

A representation of the runtime type of the object.

singleFuture<RawSocketEvent>
read-only, inherited

Returns the single element.

Operators

operator ==(other) → bool
inherited

The equality operator.

Methods

close() → void

Close the datagram socket.

joinMulticast(InternetAddress group, [ NetworkInterface interface ]) → void

Join a multicast group.

leaveMulticast(InternetAddress group, [ NetworkInterface interface ]) → void

Leave a multicast group.

receive() → Datagram

Receive a datagram. If there are no datagrams available null is returned.

send(List<int> buffer, InternetAddress address, int port) → int

Send a datagram.

any(bool test(T element)) → Future<bool>
inherited

Checks whether test accepts any element provided by this stream.

asBroadcastStream({void onListen(StreamSubscription<T> subscription), void onCancel(StreamSubscription<T> subscription) }) → Stream<RawSocketEvent>
inherited

Returns a multi-subscription stream that produces the same events as this.

asyncExpand<E>(Stream<E> convert(T event)) → Stream<E>
inherited

Creates a new stream with the events of a stream per original event.

asyncMap<E>(dynamic convert(T event)) → Stream<E>
inherited

Creates a new stream with each data event of this stream asynchronously mapped to a new event.

contains(Object needle) → Future<bool>
inherited

Checks whether needle occurs in the elements provided by this stream.

distinct([bool equals(T previous, T next) ]) → Stream<RawSocketEvent>
inherited

Skips data events if they are equal to the previous data event.

drain<E>([E futureValue ]) → Future<E>
inherited

Discards all data on the stream, but signals when it's done or an error occurred.

elementAt(int index) → Future<RawSocketEvent>
inherited

Returns the value of the indexth data event of this stream.

every(bool test(T element)) → Future<bool>
inherited

Checks whether test accepts all elements provided by this stream.

expand<S>(Iterable<S> convert(T value)) → Stream<S>
inherited

Creates a new stream from this stream that converts each element into zero or more events.

firstWhere(bool test(T element), { Object defaultValue() }) → Future
inherited

Finds the first element of this stream matching test.

fold<S>(S initialValue, S combine(S previous, T element)) → Future<S>
inherited

Reduces a sequence of values by repeatedly applying combine.

forEach(void action(T element)) → Future
inherited

Executes action on each data event of the stream.

handleError(Function onError, { bool test(error) }) → Stream<RawSocketEvent>
inherited

Creates a wrapper Stream that intercepts some errors from this stream.

join([String separator = "" ]) → Future<String>
inherited

Collects string of data events' string representations.

lastWhere(bool test(T element), { Object defaultValue() }) → Future
inherited

Finds the last element in this stream matching test.

listen(void onData(T event), { Function onError, void onDone(), bool cancelOnError }) → StreamSubscription<RawSocketEvent>
inherited

Adds a subscription to this stream.

map<S>(S convert(T event)) → Stream<S>
inherited

Creates a new stream that converts each element of this stream to a new value using the convert function.

noSuchMethod(Invocation invocation) → dynamic
inherited

Invoked when a non-existent method or property is accessed.

pipe(StreamConsumer<RawSocketEvent> streamConsumer) → Future
inherited

Pipe the events of this stream into streamConsumer.

reduce(RawSocketEvent combine(T previous, T element)) → Future<RawSocketEvent>
inherited

Reduces a sequence of values by repeatedly applying combine.

singleWhere(bool test(T element)) → Future<RawSocketEvent>
inherited

Finds the single element in this stream matching test.

skip(int count) → Stream<RawSocketEvent>
inherited

Skips the first count data events from this stream.

skipWhile(bool test(T element)) → Stream<RawSocketEvent>
inherited

Skip data events from this stream while they are matched by test.

take(int count) → Stream<RawSocketEvent>
inherited

Provides at most the first count data events of this stream.

takeWhile(bool test(T element)) → Stream<RawSocketEvent>
inherited

Forwards data events while test is successful.

timeout(Duration timeLimit, { void onTimeout(EventSink<T> sink) }) → Stream<RawSocketEvent>
inherited

Creates a new stream with the same events as this stream.

toList() → Future<List<RawSocketEvent>>
inherited

Collects the data of this stream in a List.

toSet() → Future<Set<RawSocketEvent>>
inherited

Collects the data of this stream in a Set.

toString() → String
inherited

Returns a string representation of this object.

transform<S>(StreamTransformer<RawSocketEvent, S> streamTransformer) → Stream<S>
inherited

Chains this stream as the input of the provided StreamTransformer.

where(bool test(T event)) → Stream<RawSocketEvent>
inherited

Creates a new stream from this stream that discards some data events.

© 2012 the Dart project authors
Licensed under the Creative Commons Attribution-ShareAlike License v4.0.
https://api.dartlang.org/stable/1.24.3/dart-io/RawDatagramSocket-class.html