-
Notifications
You must be signed in to change notification settings - Fork 593
/
DatagramSocket.scala
76 lines (64 loc) · 2.6 KB
/
DatagramSocket.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/*
* Copyright (c) 2013 Functional Streams for Scala
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package fs2
package io
package net
import com.comcast.ip4s._
/** Provides the ability to read/write from a UDP socket in the effect `F`.
*/
trait DatagramSocket[F[_]] extends DatagramSocketPlatform[F] {
/** Reads a single datagram from this udp socket.
*/
def read: F[Datagram]
/** Reads datagrams received from this udp socket.
*
* Note that multiple `reads` may execute at same time, causing each evaluation to receive fair
* amount of messages.
*
* @return stream of datagrams
*/
def reads: Stream[F, Datagram]
/** Writes a single datagram to this udp socket.
*
* @param datagram datagram to write
*/
def write(datagram: Datagram): F[Unit]
/** Writes supplied datagrams to this udp socket.
*/
def writes: Pipe[F, Datagram, Nothing]
/** Returns the local address of this udp socket. */
def localAddress: F[SocketAddress[IpAddress]]
/** Joins a multicast group on a specific network interface.
*
* @param join group to join
* @param interface network interface upon which to listen for datagrams
*/
def join(
join: MulticastJoin[IpAddress],
interface: DatagramSocket.NetworkInterface
): F[GroupMembership]
/** Result of joining a multicast group on a UDP socket. */
trait GroupMembership extends GroupMembershipPlatform {
/** Leaves the multicast group, resulting in no further datagrams from this group being read. */
def drop: F[Unit]
}
}
object DatagramSocket extends DatagramSocketCompanionPlatform