vibe.core.net 0/376(0%) line coverage

      
10
20
30
40
50
60
70
80
90
100
110
120
130
140
150
160
170
180
190
200
210
220
230
240
250
260
270
280
290
300
310
320
330
340
350
360
370
380
390
400
410
420
430
440
450
460
470
480
490
500
510
520
530
540
550
560
570
580
590
600
610
620
630
640
650
660
670
680
690
700
710
720
730
740
750
760
770
780
790
800
810
820
830
840
850
860
870
880
890
900
910
920
930
940
950
960
970
980
990
1000
1010
1020
1030
1040
1050
1060
1070
1080
1090
1100
1110
1120
1130
1140
1150
1160
1170
1180
1190
1200
1210
1220
1230
1240
1250
1260
1270
1280
1290
1300
1310
1320
1330
1340
1350
1360
1370
1380
1390
1400
1410
1420
1430
1440
1450
1460
1470
1480
1490
1500
1510
1520
1530
1540
1550
1560
1570
1580
1590
1600
1610
1620
1630
1640
1650
1660
1670
1680
1690
1700
1710
1720
1730
1740
1750
1760
1770
1780
1790
1800
1810
1820
1830
1840
1850
1860
1870
1880
1890
1900
1910
1920
1930
1940
1950
1960
1970
1980
1990
2000
2010
2020
2030
2040
2050
2060
2070
2080
2090
2100
2110
2120
2130
2140
2150
2160
2170
2180
2190
2200
2210
2220
2230
2240
2250
2260
2270
2280
2290
2300
2310
2320
2330
2340
2350
2360
2370
2380
2390
2400
2410
2420
2430
2440
2450
2460
2470
2480
2490
2500
2510
2520
2530
2540
2550
2560
2570
2580
2590
2600
2610
2620
2630
2640
2650
2660
2670
2680
2690
2700
2710
2720
2730
2740
2750
2760
2770
2780
2790
2800
2810
2820
2830
2840
2850
2860
2870
2880
2890
2900
2910
2920
2930
2940
2950
2960
2970
2980
2990
3000
3010
3020
3030
3040
3050
3060
3070
3080
3090
3100
3110
3120
3130
3140
3150
3160
3170
3180
3190
3200
3210
3220
3230
3240
3250
3260
3270
3280
3290
3300
3310
3320
3330
3340
3350
3360
3370
3380
3390
3400
3410
3420
3430
3440
3450
3460
3470
3480
3490
3500
3510
3520
3530
3540
3550
3560
3570
3580
3590
3600
3610
3620
3630
3640
3650
3660
3670
3680
3690
3700
3710
3720
3730
3740
3750
3760
3770
3780
3790
3800
3810
3820
3830
3840
3850
3860
3870
3880
3890
3900
3910
3920
3930
3940
3950
3960
3970
3980
3990
4000
4010
4020
4030
4040
4050
4060
4070
4080
4090
4100
4110
4120
4130
4140
4150
4160
4170
4180
4190
4200
4210
4220
4230
4240
4250
4260
4270
4280
4290
4300
4310
4320
4330
4340
4350
4360
4370
4380
4390
4400
4410
4420
4430
4440
4450
4460
4470
4480
4490
4500
4510
4520
4530
4540
4550
4560
4570
4580
4590
4600
4610
4620
4630
4640
4650
4660
4670
4680
4690
4700
4710
4720
4730
4740
4750
4760
4770
4780
4790
4800
4810
4820
4830
4840
4850
4860
4870
4880
4890
4900
4910
4920
4930
4940
4950
4960
4970
4980
4990
5000
5010
5020
5030
5040
5050
5060
5070
5080
5090
5100
5110
5120
5130
5140
5150
5160
5170
5180
5190
5200
5210
5220
5230
5240
5250
5260
5270
5280
5290
5300
5310
5320
5330
5340
5350
5360
5370
5380
5390
5400
5410
5420
5430
5440
5450
5460
5470
5480
5490
5500
5510
5520
5530
5540
5550
5560
5570
5580
5590
5600
5610
5620
5630
5640
5650
5660
5670
5680
5690
5700
5710
5720
5730
5740
5750
5760
5770
5780
5790
5800
5810
5820
5830
5840
5850
5860
5870
5880
5890
5900
5910
5920
5930
5940
5950
5960
5970
5980
5990
6000
6010
6020
6030
6040
6050
6060
6070
6080
6090
6100
6110
6120
6130
6140
6150
6160
6170
6180
6190
6200
6210
6220
6230
6240
6250
6260
6270
6280
6290
6300
6310
6320
6330
6340
6350
6360
6370
6380
6390
6400
6410
6420
6430
6440
6450
6460
6470
6480
6490
6500
6510
6520
6530
6540
6550
6560
6570
6580
6590
6600
6610
6620
6630
6640
6650
6660
6670
6680
6690
6700
6710
6720
6730
6740
6750
6760
6770
6780
6790
6800
6810
6820
6830
6840
6850
6860
6870
6880
6890
6900
6910
6920
6930
6940
6950
6960
6970
6980
6990
7000
7010
7020
7030
7040
7050
7060
7070
7080
7090
7100
7110
7120
7130
7140
7150
7160
7170
7180
7190
7200
7210
7220
7230
7240
7250
7260
7270
7280
7290
7300
7310
7320
7330
7340
7350
7360
7370
7380
7390
7400
7410
7420
7430
7440
7450
7460
7470
7480
7490
7500
7510
7520
7530
7540
7550
7560
7570
7580
7590
7600
7610
7620
7630
7640
7650
7660
7670
7680
7690
7700
7710
7720
7730
7740
7750
7760
7770
7780
7790
7800
7810
7820
7830
7840
7850
7860
7870
7880
7890
7900
7910
7920
7930
7940
7950
7960
7970
7980
7990
8000
8010
8020
8030
8040
8050
8060
8070
8080
8090
8100
8110
8120
8130
8140
8150
8160
8170
8180
8190
8200
8210
8220
8230
8240
8250
8260
8270
8280
8290
8300
8310
8320
8330
8340
8350
8360
8370
8380
8390
8400
8410
8420
8430
8440
8450
8460
8470
8480
8490
8500
8510
8520
8530
8540
8550
8560
8570
8580
8590
8600
8610
8620
8630
8640
8650
8660
8670
8680
8690
8700
8710
8720
8730
8740
8750
8760
8770
8780
8790
8800
8810
8820
8830
8840
8850
8860
8870
8880
8890
8900
8910
8920
8930
8940
8950
8960
8970
8980
8990
9000
9010
9020
9030
9040
9050
9060
9070
9080
9090
9100
9110
9120
9130
9140
9150
9160
9170
9180
9190
9200
9210
9220
9230
9240
9250
9260
9270
9280
9290
9300
9310
9320
9330
9340
9350
9360
9370
9380
9390
9400
9410
9420
9430
9440
9450
9460
9470
9480
9490
9500
9510
9520
9530
9540
9550
9560
9570
9580
9590
9600
9610
9620
9630
9640
9650
9660
9670
9680
9690
9700
9710
9720
9730
9740
9750
9760
9770
9780
9790
9800
9810
9820
9830
9840
9850
9860
9870
9880
9890
9900
9910
9920
9930
9940
9950
9960
9970
9980
9990
10000
10010
10020
10030
10040
10050
10060
10070
10080
10090
10100
10110
10120
10130
10140
10150
10160
10170
10180
10190
10200
10210
10220
/** TCP/UDP connection and server handling. Copyright: © 2012-2016 RejectedSoftware e.K. Authors: Sönke Ludwig License: Subject to the terms of the MIT license, as written in the included LICENSE.txt file. */ module vibe.core.net; import eventcore.core; import std.exception : enforce; import std.format : format; import std.functional : toDelegate; import std.socket : AddressFamily, UnknownAddress; import vibe.core.log; import vibe.core.stream; import vibe.internal.async; import core.time : Duration; @safe: /** Resolves the given host name/IP address string. Setting use_dns to false will only allow IP address strings but also guarantees that the call will not block. */ NetworkAddress resolveHost(string host, AddressFamily address_family = AddressFamily.UNSPEC, bool use_dns = true) { return resolveHost(host, cast(ushort)address_family, use_dns); } /// ditto NetworkAddress resolveHost(string host, ushort address_family, bool use_dns = true) { import std.socket : parseAddress; version (Windows) import core.sys.windows.winsock2 : sockaddr_in, sockaddr_in6; else import core.sys.posix.netinet.in_ : sockaddr_in, sockaddr_in6; enforce(host.length > 0, "Host name must not be empty."); if (host[0] == ':' || host[0] >= '0' && host[0] <= '9') { auto addr = parseAddress(host); enforce(address_family == AddressFamily.UNSPEC || addr.addressFamily == address_family); NetworkAddress ret; ret.family = addr.addressFamily; switch (addr.addressFamily) with(AddressFamily) { default: throw new Exception("Unsupported address family"); case INET: *ret.sockAddrInet4 = () @trusted { return *cast(sockaddr_in*)addr.name; } (); break; case INET6: *ret.sockAddrInet6 = () @trusted { return *cast(sockaddr_in6*)addr.name; } (); break; } return ret; } else { enforce(use_dns, "Malformed IP address string."); NetworkAddress res; bool success = false; alias waitable = Waitable!(DNSLookupCallback, cb => eventDriver.dns.lookupHost(host, cb), (cb, id) => eventDriver.dns.cancelLookup(id), (DNSLookupID, DNSStatus status, scope RefAddress[] addrs) { if (status == DNSStatus.ok && addrs.length > 0) { try res = NetworkAddress(addrs[0]); catch (Exception e) { logDiagnostic("Failed to store address from DNS lookup: %s", e.msg); } success = true; } } ); asyncAwaitAny!(true, waitable); enforce(success, "Failed to lookup host '"~host~"'."); return res; } } /** Starts listening on the specified port. 'connection_callback' will be called for each client that connects to the server socket. Each new connection gets its own fiber. The stream parameter then allows to perform blocking I/O on the client socket. The address parameter can be used to specify the network interface on which the server socket is supposed to listen for connections. By default, all IPv4 and IPv6 interfaces will be used. */ TCPListener[] listenTCP(ushort port, TCPConnectionDelegate connection_callback, TCPListenOptions options = TCPListenOptions.defaults) { TCPListener[] ret; try ret ~= listenTCP(port, connection_callback, "::", options); catch (Exception e) logDiagnostic("Failed to listen on \"::\": %s", e.msg); try ret ~= listenTCP(port, connection_callback, "0.0.0.0", options); catch (Exception e) logDiagnostic("Failed to listen on \"0.0.0.0\": %s", e.msg); enforce(ret.length > 0, format("Failed to listen on all interfaces on port %s", port)); return ret; } /// ditto TCPListener listenTCP(ushort port, TCPConnectionDelegate connection_callback, string address, TCPListenOptions options = TCPListenOptions.defaults) { auto addr = resolveHost(address); addr.port = port; StreamListenOptions sopts = StreamListenOptions.defaults; if (options & TCPListenOptions.reusePort) sopts |= StreamListenOptions.reusePort; scope addrc = new RefAddress(addr.sockAddr, addr.sockAddrLen); auto sock = eventDriver.sockets.listenStream(addrc, sopts, (StreamListenSocketFD ls, StreamSocketFD s, scope RefAddress addr) @safe nothrow { import vibe.core.core : runTask; auto conn = TCPConnection(s, addr); runTask(connection_callback, conn); }); enforce(sock != StreamListenSocketFD.invalid, "Failed to listen on "~addr.toString()); return TCPListener(sock); } /// Compatibility overload - use an `@safe nothrow` callback instead. deprecated("Use a @safe nothrow callback instead.") TCPListener[] listenTCP(ushort port, void delegate(TCPConnection) connection_callback, TCPListenOptions options = TCPListenOptions.defaults) { TCPListener[] ret; try ret ~= listenTCP(port, connection_callback, "::", options); catch (Exception e) logDiagnostic("Failed to listen on \"::\": %s", e.msg); try ret ~= listenTCP(port, connection_callback, "0.0.0.0", options); catch (Exception e) logDiagnostic("Failed to listen on \"0.0.0.0\": %s", e.msg); enforce(ret.length > 0, format("Failed to listen on all interfaces on port %s", port)); return ret; } /// ditto deprecated("Use a @safe nothrow callback instead.") TCPListener listenTCP(ushort port, void delegate(TCPConnection) connection_callback, string address, TCPListenOptions options = TCPListenOptions.defaults) { return listenTCP(port, (conn) @trusted nothrow { try connection_callback(conn); catch (Exception e) { logError("Handling of connection failed: %s", e.msg); conn.close(); } }, address, options); } /** Starts listening on the specified port. This function is the same as listenTCP but takes a function callback instead of a delegate. */ TCPListener[] listenTCP_s(ushort port, TCPConnectionFunction connection_callback, TCPListenOptions options = TCPListenOptions.defaults) { return listenTCP(port, toDelegate(connection_callback), options); } /// ditto TCPListener listenTCP_s(ushort port, TCPConnectionFunction connection_callback, string address, TCPListenOptions options = TCPListenOptions.defaults) { return listenTCP(port, toDelegate(connection_callback), address, options); } /** Establishes a connection to the given host/port. */ TCPConnection connectTCP(string host, ushort port, string bind_interface = null, ushort bind_port = 0, Duration timeout = Duration.max) { NetworkAddress addr = resolveHost(host); addr.port = port; if (addr.family != AddressFamily.UNIX) addr.port = port; NetworkAddress bind_address; if (bind_interface.length) bind_address = resolveHost(bind_interface, addr.family); else { bind_address.family = addr.family; if (bind_address.family == AddressFamily.INET) bind_address.sockAddrInet4.sin_addr.s_addr = 0; else if (bind_address.family != AddressFamily.UNIX) bind_address.sockAddrInet6.sin6_addr.s6_addr[] = 0; } if (addr.family != AddressFamily.UNIX) bind_address.port = bind_port; return connectTCP(addr, bind_address, timeout); } /// ditto TCPConnection connectTCP(NetworkAddress addr, NetworkAddress bind_address = anyAddress, Duration timeout = Duration.max) { import std.conv : to; if (bind_address.family == AddressFamily.UNSPEC) { bind_address.family = addr.family; if (bind_address.family == AddressFamily.INET) bind_address.sockAddrInet4.sin_addr.s_addr = 0; else if (bind_address.family != AddressFamily.UNIX) bind_address.sockAddrInet6.sin6_addr.s6_addr[] = 0; if (bind_address.family != AddressFamily.UNIX) bind_address.port = 0; } enforce(addr.family == bind_address.family, "Destination address and bind address have different address families."); return () @trusted { // scope scope uaddr = new RefAddress(addr.sockAddr, addr.sockAddrLen); scope baddr = new RefAddress(bind_address.sockAddr, bind_address.sockAddrLen); bool cancelled; StreamSocketFD sock; ConnectStatus status; alias waiter = Waitable!(ConnectCallback, cb => eventDriver.sockets.connectStream(uaddr, baddr, cb), (cb, sock_fd) { cancelled = true; eventDriver.sockets.cancelConnectStream(sock_fd); }, (fd, st) { sock = fd; status = st; } ); asyncAwaitAny!(true, waiter)(timeout); enforce(!cancelled, "Failed to connect to " ~ addr.toString() ~ ": timeout"); enforce(status == ConnectStatus.connected, "Failed to connect to "~addr.toString()~": "~status.to!string); return TCPConnection(sock, uaddr); } (); } /** Creates a bound UDP socket suitable for sending and receiving packets. */ UDPConnection listenUDP(ref NetworkAddress addr) { return UDPConnection(addr); } /// ditto UDPConnection listenUDP(ushort port, string bind_address = "0.0.0.0") { auto addr = resolveHost(bind_address, AddressFamily.UNSPEC, false); addr.port = port; return UDPConnection(addr); } NetworkAddress anyAddress() { NetworkAddress ret; ret.family = AddressFamily.UNSPEC; return ret; } /// Callback invoked for incoming TCP connections. @safe nothrow alias TCPConnectionDelegate = void delegate(TCPConnection stream); /// ditto @safe nothrow alias TCPConnectionFunction = void delegate(TCPConnection stream); /** Represents a network/socket address. */ struct NetworkAddress { import std.algorithm.comparison : max; import std.socket : Address; version (Windows) import core.sys.windows.winsock2; else import core.sys.posix.netinet.in_; version(Posix) import core.sys.posix.sys.un : sockaddr_un; @safe: private union { sockaddr addr; version (Posix) sockaddr_un addr_unix; sockaddr_in addr_ip4; sockaddr_in6 addr_ip6; } enum socklen_t sockAddrMaxLen = max(addr.sizeof, addr_ip6.sizeof); this(Address addr) @trusted { assert(addr !is null); switch (addr.addressFamily) { default: throw new Exception("Unsupported address family."); case AddressFamily.INET: this.family = AddressFamily.INET; assert(addr.nameLen >= sockaddr_in.sizeof); *this.sockAddrInet4 = *cast(sockaddr_in*)addr.name; break; case AddressFamily.INET6: this.family = AddressFamily.INET6; assert(addr.nameLen >= sockaddr_in6.sizeof); *this.sockAddrInet6 = *cast(sockaddr_in6*)addr.name; break; version (Posix) { case AddressFamily.UNIX: this.family = AddressFamily.UNIX; assert(addr.nameLen >= sockaddr_un.sizeof); *this.sockAddrUnix = *cast(sockaddr_un*)addr.name; break; } } } /** Family of the socket address. */ @property ushort family() const pure nothrow { return addr.sa_family; } /// ditto @property void family(AddressFamily val) pure nothrow { addr.sa_family = cast(ubyte)val; } /// ditto @property void family(ushort val) pure nothrow { addr.sa_family = cast(ubyte)val; } /** The port in host byte order. */ @property ushort port() const pure nothrow { ushort nport; switch (this.family) { default: assert(false, "port() called for invalid address family."); case AF_INET: nport = addr_ip4.sin_port; break; case AF_INET6: nport = addr_ip6.sin6_port; break; } return () @trusted { return ntoh(nport); } (); } /// ditto @property void port(ushort val) pure nothrow { auto nport = () @trusted { return hton(val); } (); switch (this.family) { default: assert(false, "port() called for invalid address family."); case AF_INET: addr_ip4.sin_port = nport; break; case AF_INET6: addr_ip6.sin6_port = nport; break; } } /** A pointer to a sockaddr struct suitable for passing to socket functions. */ @property inout(sockaddr)* sockAddr() inout pure nothrow { return &addr; } /** Size of the sockaddr struct that is returned by sockAddr(). */ @property socklen_t sockAddrLen() const pure nothrow { switch (this.family) { default: assert(false, "sockAddrLen() called for invalid address family."); case AF_INET: return addr_ip4.sizeof; case AF_INET6: return addr_ip6.sizeof; version (Posix) { case AF_UNIX: return addr_unix.sizeof; } } } @property inout(sockaddr_in)* sockAddrInet4() inout pure nothrow in { assert (family == AF_INET); } body { return &addr_ip4; } @property inout(sockaddr_in6)* sockAddrInet6() inout pure nothrow in { assert (family == AF_INET6); } body { return &addr_ip6; } version (Posix) { @property inout(sockaddr_un)* sockAddrUnix() inout pure nothrow in { assert (family == AddressFamily.UNIX); } body { return &addr_unix; } } /** Returns a string representation of the IP address */ string toAddressString() const nothrow { import std.array : appender; auto ret = appender!string(); ret.reserve(40); toAddressString(str => ret.put(str)); return ret.data; } /// ditto void toAddressString(scope void delegate(const(char)[]) @safe sink) const nothrow { import std.array : appender; import std.format : formattedWrite; ubyte[2] _dummy = void; // Workaround for DMD regression in master scope (failure) assert(false); switch (this.family) { default: assert(false, "toAddressString() called for invalid address family."); case AF_UNSPEC: sink("<UNSPEC>"); break; case AF_INET: { ubyte[4] ip = () @trusted { return (cast(ubyte*)&addr_ip4.sin_addr.s_addr)[0 .. 4]; } (); sink.formattedWrite("%d.%d.%d.%d", ip[0], ip[1], ip[2], ip[3]); } break; case AF_INET6: { ubyte[16] ip = addr_ip6.sin6_addr.s6_addr; foreach (i; 0 .. 8) { if (i > 0) sink(":"); _dummy[] = ip[i*2 .. i*2+2]; sink.formattedWrite("%x", bigEndianToNative!ushort(_dummy)); } } break; version (Posix) { case AddressFamily.UNIX: import std.traits : hasMember; import std.string : fromStringz; static if (hasMember!(sockaddr_un, "sun_len")) sink(() @trusted { return cast(char[])addr_unix.sun_path[0..addr_unix.sun_len]; } ()); else sink(() @trusted { return (cast(char*)addr_unix.sun_path.ptr).fromStringz; } ()); break; } } } /** Returns a full string representation of the address, including the port number. */ string toString() const nothrow { import std.array : appender; auto ret = appender!string(); toString(str => ret.put(str)); return ret.data; } /// ditto void toString(scope void delegate(const(char)[]) @safe sink) const nothrow { import std.format : formattedWrite; try { switch (this.family) { default: assert(false, "toString() called for invalid address family."); case AF_UNSPEC: sink("<UNSPEC>"); break; case AF_INET: toAddressString(sink); sink.formattedWrite(":%s", port); break; case AF_INET6: sink("["); toAddressString(sink); sink.formattedWrite("]:%s", port); break; case AddressFamily.UNIX: toAddressString(sink); break; } } catch (Exception e) { assert(false, "Unexpected exception: "~e.msg); } } version(Have_libev) {} else { unittest { void test(string ip) { auto res = () @trusted { return resolveHost(ip, AF_UNSPEC, false); } ().toAddressString(); assert(res == ip, "IP "~ip~" yielded wrong string representation: "~res); } test("1.2.3.4"); test("102:304:506:708:90a:b0c:d0e:f10"); } } } /** Represents a single TCP connection. */ struct TCPConnection { @safe: import core.time : seconds; import vibe.internal.array : BatchBuffer; //static assert(isConnectionStream!TCPConnection); static struct Context { BatchBuffer!ubyte readBuffer; bool tcpNoDelay = false; bool keepAlive = false; Duration readTimeout = Duration.max; string remoteAddressString; } private { StreamSocketFD m_socket; Context* m_context; } private this(StreamSocketFD socket, scope RefAddress remote_address) nothrow { import std.exception : enforce; m_socket = socket; m_context = () @trusted { return &eventDriver.sockets.userData!Context(socket); } (); m_context.readBuffer.capacity = 4096; } this(this) nothrow { if (m_socket != StreamSocketFD.invalid) eventDriver.sockets.addRef(m_socket); } ~this() nothrow { if (m_socket != StreamSocketFD.invalid) eventDriver.sockets.releaseRef(m_socket); } bool opCast(T)() const nothrow if (is(T == bool)) { return m_socket != StreamSocketFD.invalid; } @property void tcpNoDelay(bool enabled) nothrow { eventDriver.sockets.setTCPNoDelay(m_socket, enabled); m_context.tcpNoDelay = enabled; } @property bool tcpNoDelay() const nothrow { return m_context.tcpNoDelay; } @property void keepAlive(bool enabled) nothrow { eventDriver.sockets.setKeepAlive(m_socket, enabled); m_context.keepAlive = enabled; } @property bool keepAlive() const nothrow { return m_context.keepAlive; } @property void readTimeout(Duration duration) { m_context.readTimeout = duration; } @property Duration readTimeout() const nothrow { return m_context.readTimeout; } @property string peerAddress() const nothrow { return this.remoteAddress.toString(); } @property NetworkAddress localAddress() const nothrow { NetworkAddress naddr; scope addr = new RefAddress(naddr.sockAddr, naddr.sockAddrMaxLen); if (!eventDriver.sockets.getLocalAddress(m_socket, addr)) logWarn("Failed to get local address for TCP connection"); return naddr; } @property NetworkAddress remoteAddress() const nothrow { NetworkAddress naddr; scope addr = new RefAddress(naddr.sockAddr, naddr.sockAddrMaxLen); if (!eventDriver.sockets.getRemoteAddress(m_socket, addr)) logWarn("Failed to get remote address for TCP connection"); return naddr; } @property bool connected() const nothrow { if (m_socket == StreamSocketFD.invalid) return false; auto s = eventDriver.sockets.getConnectionState(m_socket); return s >= ConnectionState.connected && s < ConnectionState.activeClose; } @property bool empty() { return leastSize == 0; } @property ulong leastSize() { waitForData(); return m_context ? m_context.readBuffer.length : 0; } @property bool dataAvailableForRead() { return waitForData(0.seconds); } void close() nothrow { //logInfo("close %s", cast(int)m_fd); if (m_socket != StreamSocketFD.invalid) { eventDriver.sockets.shutdown(m_socket, true, true); eventDriver.sockets.releaseRef(m_socket); m_socket = StreamSocketFD.invalid; m_context = null; } } bool waitForData(Duration timeout = Duration.max) { mixin(tracer); if (!m_context) return false; if (m_context.readBuffer.length > 0) return true; auto mode = timeout <= 0.seconds ? IOMode.immediate : IOMode.once; bool cancelled; IOStatus status; size_t nbytes; alias waiter = Waitable!(IOCallback, cb => eventDriver.sockets.read(m_socket, m_context.readBuffer.peekDst(), mode, cb), (cb) { cancelled = true; eventDriver.sockets.cancelRead(m_socket); }, (sock, st, nb) { assert(sock == m_socket); status = st; nbytes = nb; } ); asyncAwaitAny!(true, waiter)(timeout); if (cancelled) return false; logTrace("Socket %s, read %s bytes: %s", m_socket, nbytes, status); assert(m_context.readBuffer.length == 0); m_context.readBuffer.putN(nbytes); switch (status) { default: logDebug("Error status when waiting for data: %s", status); break; case IOStatus.ok: break; case IOStatus.wouldBlock: assert(mode == IOMode.immediate); break; case IOStatus.disconnected: break; } return m_context.readBuffer.length > 0; } /** Waits asynchronously for new data to arrive. This function can be used to detach the `TCPConnection` from a running task while waiting for data, so that the associated memory resources are available for other operations. Note that `read_ready_callback` may be called from outside of a task, so no blocking operations may be performed. Instead, an existing task should be notified, or a new one started with `runTask`. Params: read_ready_callback = A callback taking a `bool` parameter that signals the read-readiness of the connection timeout = Optional timeout to limit the maximum wait time Returns: If the read readiness can be determined immediately, it will be returned as WaitForDataAsyncStatus.sataAvailable` or `WaitForDataAsyncStatus.noModeData` and the callback will not be invoked. Otherwise `WaitForDataAsyncStatus.waiting` is returned and the callback will be invoked once the status can be determined or the specified timeout is reached. */ WaitForDataAsyncStatus waitForDataAsync(CALLABLE)(CALLABLE read_ready_callback, Duration timeout = Duration.max) if (is(typeof(() @safe { read_ready_callback(true); } ()))) { mixin(tracer); import vibe.core.core : setTimer; if (!m_context) return WaitForDataAsyncStatus.noMoreData; if (m_context.readBuffer.length > 0) return WaitForDataAsyncStatus.dataAvailable; if (timeout <= 0.seconds) { auto rs = waitForData(0.seconds); return rs ? WaitForDataAsyncStatus.dataAvailable : WaitForDataAsyncStatus.noMoreData; } auto tm = setTimer(timeout, { eventDriver.sockets.cancelRead(m_socket); read_ready_callback(false); }); eventDriver.sockets.read(m_socket, m_context.readBuffer.peekDst(), IOMode.once, (sock, st, nb) { tm.stop(); assert(m_context.readBuffer.length == 0); m_context.readBuffer.putN(nb); read_ready_callback(m_context.readBuffer.length > 0); }); return WaitForDataAsyncStatus.waiting; } const(ubyte)[] peek() { return m_context ? m_context.readBuffer.peek() : null; } void skip(ulong count) { import std.algorithm.comparison : min; m_context.readTimeout.loopWithTimeout!((remaining) { waitForData(remaining); auto n = min(count, m_context.readBuffer.length); m_context.readBuffer.popFrontN(n); count -= n; return count == 0; }); } size_t read(scope ubyte[] dst, IOMode mode) { mixin(tracer); import std.algorithm.comparison : min; if (!dst.length) return 0; size_t nbytes = 0; m_context.readTimeout.loopWithTimeout!((remaining) { if (m_context.readBuffer.length == 0) { if (mode == IOMode.immediate || mode == IOMode.once && nbytes > 0) return true; enforce(waitForData(remaining), "Reached end of stream while reading data."); } assert(m_context.readBuffer.length > 0); auto l = min(dst.length, m_context.readBuffer.length); m_context.readBuffer.read(dst[0 .. l]); dst = dst[l .. $]; nbytes += l; return dst.length == 0; }); return nbytes; } void read(scope ubyte[] dst) { auto r = read(dst, IOMode.all); assert(r == dst.length); } size_t write(in ubyte[] bytes, IOMode mode) { mixin(tracer); if (bytes.length == 0) return 0; auto res = asyncAwait!(IOCallback, cb => eventDriver.sockets.write(m_socket, bytes, mode, cb), cb => eventDriver.sockets.cancelWrite(m_socket)); switch (res[1]) { default: throw new Exception("Error writing data to socket."); case IOStatus.ok: break; case IOStatus.disconnected: break; } return res[2]; } void write(in ubyte[] bytes) { auto r = write(bytes, IOMode.all); assert(r == bytes.length); } void write(in char[] bytes) { write(cast(const(ubyte)[])bytes); } void write(InputStream stream) { write(stream, 0); } void flush() { mixin(tracer); } void finalize() {} void write(InputStream)(InputStream stream, ulong nbytes = 0) if (isInputStream!InputStream) { writeDefault(stream, nbytes); } private void writeDefault(InputStream)(InputStream stream, ulong nbytes = 0) if (isInputStream!InputStream) { import std.algorithm.comparison : min; import vibe.internal.allocator : theAllocator, makeArray, dispose; scope buffer = () @trusted { return cast(ubyte[]) theAllocator.allocate(64*1024); }(); scope (exit) () @trusted { theAllocator.dispose(buffer); }(); //logTrace("default write %d bytes, empty=%s", nbytes, stream.empty); if( nbytes == 0 ){ while( !stream.empty ){ size_t chunk = min(stream.leastSize, buffer.length); assert(chunk > 0, "leastSize returned zero for non-empty stream."); //logTrace("read pipe chunk %d", chunk); stream.read(buffer[0 .. chunk]); write(buffer[0 .. chunk]); } } else { while( nbytes > 0 ){ size_t chunk = min(nbytes, buffer.length); //logTrace("read pipe chunk %d", chunk); stream.read(buffer[0 .. chunk]); write(buffer[0 .. chunk]); nbytes -= chunk; } } } } /** Represents possible return values for TCPConnection.waitForDataAsync. */ enum WaitForDataAsyncStatus { noMoreData, dataAvailable, waiting, } mixin validateConnectionStream!TCPConnection; private void loopWithTimeout(alias LoopBody, ExceptionType = Exception)(Duration timeout) { import core.time : seconds; import std.datetime : Clock, SysTime, UTC; SysTime now; if (timeout != Duration.max) now = Clock.currTime(UTC()); do { if (LoopBody(timeout)) return; if (timeout != Duration.max) { auto prev = now; now = Clock.currTime(UTC()); if (now > prev) timeout -= now - prev; } } while (timeout > 0.seconds); throw new ExceptionType("Operation timed out."); } /** Represents a listening TCP socket. */ struct TCPListener { // FIXME: copying may lead to dangling FDs - this somehow needs to employ reference counting without breaking // the previous behavior of keeping the socket alive when the listener isn't stored. At the same time, // stopListening() needs to keep working. private { StreamListenSocketFD m_socket; } this(StreamListenSocketFD socket) { m_socket = socket; } bool opCast(T)() const nothrow if (is(T == bool)) { return m_socket != StreamListenSocketFD.invalid; } /// The local address at which TCP connections are accepted. @property NetworkAddress bindAddress() { NetworkAddress ret; scope ra = new RefAddress(ret.sockAddr, ret.sockAddrMaxLen); enforce(eventDriver.sockets.getLocalAddress(m_socket, ra), "Failed to query bind address of listening socket."); return ret; } /// Stops listening and closes the socket. void stopListening() { if (m_socket != StreamListenSocketFD.invalid) { eventDriver.sockets.releaseRef(m_socket); m_socket = StreamListenSocketFD.invalid; } } } /** Represents a bound and possibly 'connected' UDP socket. */ struct UDPConnection { static struct Context { bool canBroadcast; } private { DatagramSocketFD m_socket; Context* m_context; } private this(ref NetworkAddress bind_address) { scope baddr = new RefAddress(bind_address.sockAddr, bind_address.sockAddrLen); m_socket = eventDriver.sockets.createDatagramSocket(baddr, null); enforce(m_socket != DatagramSocketFD.invalid, "Failed to create datagram socket."); m_context = () @trusted { return &eventDriver.sockets.userData!Context(m_socket); } (); } this(this) nothrow { if (m_socket != StreamSocketFD.invalid) eventDriver.sockets.addRef(m_socket); } ~this() nothrow { if (m_socket != StreamSocketFD.invalid) eventDriver.sockets.releaseRef(m_socket); } bool opCast(T)() const nothrow if (is(T == bool)) { return m_socket != DatagramSocketFD.invalid; } /** Returns the address to which the UDP socket is bound. */ @property string bindAddress() const { return localAddress.toString(); } /** Determines if the socket is allowed to send to broadcast addresses. */ @property bool canBroadcast() const { return m_context.canBroadcast; } /// ditto @property void canBroadcast(bool val) { enforce(eventDriver.sockets.setBroadcast(m_socket, val), "Failed to set UDP broadcast flag."); m_context.canBroadcast = val; } /// The local/bind address of the underlying socket. @property NetworkAddress localAddress() const nothrow { NetworkAddress naddr; scope addr = new RefAddress(naddr.sockAddr, naddr.sockAddrMaxLen); try { enforce(eventDriver.sockets.getLocalAddress(m_socket, addr), "Failed to query socket address."); } catch (Exception e) { logWarn("Failed to get local address for TCP connection: %s", e.msg); } return naddr; } /** Set IP multicast loopback mode. This is on by default. All packets send will also loopback if enabled. Useful if more than one application is running on same host and both need each other's packets. */ @property void multicastLoopback(bool loop) { enforce(eventDriver.sockets.setOption(m_socket, DatagramSocketOption.multicastLoopback, loop), "Failed to set multicast loopback mode."); } /** Become a member of an IP multicast group. The multiaddr parameter should be in the range 239.0.0.0-239.255.255.255. See https://www.iana.org/assignments/multicast-addresses/multicast-addresses.xml#multicast-addresses-12 and https://www.iana.org/assignments/ipv6-multicast-addresses/ipv6-multicast-addresses.xhtml */ void addMembership(ref NetworkAddress multiaddr, uint interface_index = 0) { scope addr = new RefAddress(multiaddr.sockAddr, multiaddr.sockAddrMaxLen); enforce(eventDriver.sockets.joinMulticastGroup(m_socket, addr, interface_index), "Failed to add multicast membership."); } /** Stops listening for datagrams and frees all resources. */ void close() { eventDriver.sockets.releaseRef(m_socket); m_socket = DatagramSocketFD.init; } /** Locks the UDP connection to a certain peer. Once connected, the UDPConnection can only communicate with the specified peer. Otherwise communication with any reachable peer is possible. */ void connect(string host, ushort port) { connect(resolveHost(host, port)); } /// ditto void connect(NetworkAddress address) { scope addr = new RefAddress(address.sockAddr, address.sockAddrLen); eventDriver.sockets.setTargetAddress(m_socket, addr); } /** Sends a single packet. If peer_address is given, the packet is send to that address. Otherwise the packet will be sent to the address specified by a call to connect(). */ void send(in ubyte[] data, in NetworkAddress* peer_address = null) { scope addrc = new RefAddress; if (peer_address) addrc.set(() @trusted { return (cast(NetworkAddress*)peer_address).sockAddr; } (), peer_address.sockAddrLen); IOStatus status; size_t nbytes; bool cancelled; alias waitable = Waitable!(DatagramIOCallback, cb => eventDriver.sockets.send(m_socket, data, IOMode.once, peer_address ? addrc : null, cb), (cb) { cancelled = true; eventDriver.sockets.cancelSend(m_socket); }, (DatagramSocketFD, IOStatus status_, size_t nbytes_, scope RefAddress addr) { status = status_; nbytes = nbytes_; } ); asyncAwaitAny!(true, waitable); enforce(!cancelled && status == IOStatus.ok, "Failed to send packet."); enforce(nbytes == data.length, "Packet was only sent partially."); } /** Receives a single packet. If a buffer is given, it must be large enough to hold the full packet. The timeout overload will throw an Exception if no data arrives before the specified duration has elapsed. */ ubyte[] recv(ubyte[] buf = null, NetworkAddress* peer_address = null) { return recv(Duration.max, buf, peer_address); } /// ditto ubyte[] recv(Duration timeout, ubyte[] buf = null, NetworkAddress* peer_address = null) { import std.socket : Address; if (buf.length == 0) buf = new ubyte[65536]; IOStatus status; size_t nbytes; bool cancelled; alias waitable = Waitable!(DatagramIOCallback, cb => eventDriver.sockets.receive(m_socket, buf, IOMode.once, cb), (cb) { cancelled = true; eventDriver.sockets.cancelReceive(m_socket); }, (DatagramSocketFD, IOStatus status_, size_t nbytes_, scope RefAddress addr) { status = status_; nbytes = nbytes_; if (status_ == IOStatus.ok && peer_address) { try *peer_address = NetworkAddress(addr); catch (Exception e) logWarn("Failed to store datagram source address: %s", e.msg); } } ); asyncAwaitAny!(true, waitable)(timeout); enforce(!cancelled, "Receive timeout."); enforce(status == IOStatus.ok, "Failed to receive packet."); return buf[0 .. nbytes]; } } /** Flags to control the behavior of listenTCP. */ enum TCPListenOptions { /// Don't enable any particular option defaults = 0, /// Deprecated: causes incoming connections to be distributed across the thread pool distribute = 1<<0, /// Disables automatic closing of the connection when the connection callback exits disableAutoClose = 1<<1, /** Enable port reuse on linux kernel version >=3.9, do nothing on other OS Does not affect libasync driver because it is always enabled by libasync. */ reusePort = 1<<2, } private pure nothrow { import std.bitmanip; ushort ntoh(ushort val) { version (LittleEndian) return swapEndian(val); else version (BigEndian) return val; else static assert(false, "Unknown endianness."); } ushort hton(ushort val) { version (LittleEndian) return swapEndian(val); else version (BigEndian) return val; else static assert(false, "Unknown endianness."); } } private enum tracer = "";