-
Notifications
You must be signed in to change notification settings - Fork 593
/
Network.scala
65 lines (59 loc) · 2.4 KB
/
Network.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
/*
* 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 fs2.io.net.tls.TLSContext
/** Provides the ability to work with TCP, UDP, and TLS.
*
* @example {{{
* import fs2.Stream
* import fs2.io.net.{Datagram, Network}
*
* def send[F[_]: Network](datagram: Datagram): F[Unit] =
* Network[F].openDatagramSocket().use { socket =>
* socket.write(packet)
* }
* }}}
*
* In this example, the `F[_]` parameter to `send` requires the `Network` constraint instead
* of requiring the much more powerful `Async` constraint.
*
* The `Network` instance has a set of global resources used for managing sockets. Alternatively,
* use the `socketGroup` and `datagramSocketGroup` operations to manage the lifecycle of underlying
* resources.
*
* An instance of `Network` is available for any effect `F` which has an `Async[F]` instance.
*/
sealed trait Network[F[_]]
extends NetworkPlatform[F]
with SocketGroup[F]
with DatagramSocketGroup[F] {
/** Returns a builder for `TLSContext[F]` values.
*
* For example, `Network[IO].tlsContext.system` returns a `F[TLSContext[F]]`.
*/
def tlsContext: TLSContext.Builder[F]
}
object Network extends NetworkCompanionPlatform {
private[fs2] trait UnsealedNetwork[F[_]] extends Network[F]
def apply[F[_]](implicit F: Network[F]): F.type = F
}