-
Notifications
You must be signed in to change notification settings - Fork 668
/
DatagramSocket.java
1799 lines (1584 loc) · 71.2 KB
/
DatagramSocket.java
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 1995, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package java.net;
import java.io.Closeable;
import java.io.IOException;
import java.nio.channels.DatagramChannel;
import java.security.AccessController;
import java.security.PrivilegedExceptionAction;
import java.util.Collections;
import java.util.Set;
/**
* This class represents a socket for sending and receiving datagram packets.
*
* <p>A datagram socket is the sending or receiving point for a packet
* delivery service. Each packet sent or received on a datagram socket
* is individually addressed and routed. Multiple packets sent from
* one machine to another may be routed differently, and may arrive in
* any order.
*
* <p> Where possible, a newly constructed {@code DatagramSocket} has the
* {@link SocketOptions#SO_BROADCAST SO_BROADCAST} socket option enabled so as
* to allow the transmission of broadcast datagrams. In order to receive
* broadcast packets a DatagramSocket should be bound to the wildcard address.
* In some implementations, broadcast packets may also be received when
* a DatagramSocket is bound to a more specific address.
* <p>
* Example:
* {@code
* DatagramSocket s = new DatagramSocket(null);
* s.bind(new InetSocketAddress(8888));
* }
* Which is equivalent to:
* {@code
* DatagramSocket s = new DatagramSocket(8888);
* }
* Both cases will create a DatagramSocket able to receive broadcasts on
* UDP port 8888.
*
* @author Pavani Diwanji
* @see java.net.DatagramPacket
* @see java.nio.channels.DatagramChannel
* @since 1.0
*/
/*
* 无连接的Socket(使用UDP Socket)
*
*
* Linux上的UDP通信方法:
*
* 服务端 客户端
*
* sokcet() sokcet()
* ↓ ↓
* bind() bind()
* ↓ ↓
* readfrom() ↓
* ↓ ↓
* 阻塞,等待客户端连接 ↓
* ↓ ↓
* ↓ 客户端发出请求 ↓
* █ ←←←←←←←←←←←← sendto()
* ↓ ↓
* 服务端处理请求 ↓
* 服务端做出响应 ↓
* ↓ ↓
* ↓ 客户端接收响应 ↓
* sendto() →→→→→→→→→→→ readfrom()
* ↓ ↓
* close() close()
*
*
* UDP-Scoket可以实现单播、广播、组播:
* 单播和广播均可以用DatagramSocket类完成,而组播需要使用其子类MulticastSocket来完成。
*
* 注:客户端与服务端是一个相对的概念,没有绝对的客户端或绝对的服务端
*/
public class DatagramSocket implements Closeable {
/**
* The implementation of this DatagramSocket.
*/
// "UDP-Socket委托",用来完成位于双端的UDP-Socket之间的通讯
DatagramSocketImpl impl;
/**
* Are we using an older DatagramSocketImpl?
*/
// 是否在使用旧式的"UDP-Socket委托"(JDK1.5起始,该值均为false)
boolean oldImpl = false;
/**
* User defined factory for all datagram sockets.
*/
// "UDP-Socket委托"的工厂
static DatagramSocketImplFactory factory;
/**
* Connection state:
*
* ST_NOT_CONNECTED = socket not connected
* ST_CONNECTED = socket connected
* ST_CONNECTED_NO_IMPL = socket connected but not at impl level
*/
// UDP-Socket的连接状态标记
static final int ST_NOT_CONNECTED = 0; // 未连接
static final int ST_CONNECTED = 1; // 已连接
static final int ST_CONNECTED_NO_IMPL = 2; // "模拟已连接",通常是发起了连接操作,但是连接失败了,或者是本地禁止了连接
// UDP-Socket的连接状态初始化为未连接
int connectState = ST_NOT_CONNECTED;
/**
* Connected address & port
*/
InetAddress connectedAddress = null; // 远端的连接IP
int connectedPort = -1; // 远端的连接端口
private static Set<SocketOption<?>> options; // DatagramSocket配置参数
private static boolean optionsSet = false; // 懒加载,标记是否初始化了DatagramSocket配置参数
/**
* Various states of this socket.
*/
private boolean created = false; // UDP-Socket是否已创建
private boolean bound = false; // UDP-Socket是否已绑定
private boolean closed = false; // UDP-Socket是否已关闭
private Object closeLock = new Object();
/**
* Set when a socket is ST_CONNECTED until we are certain
* that any packets which might have been received prior
* to calling connect() but not read by the application
* have been read. During this time we check the source
* address of all packets received to be sure they are from
* the connected destination. Other packets are read but
* silently dropped.
*/
// 是否需要显式校验/过滤数据
private boolean explicitFilter = false;
// 记录需要被检验/过滤的字节数量,初始时与输入缓冲区的容量大小一致
private int bytesLeftToFilter;
/*▼ 构造器 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Creates a datagram socket, bound to the specified local
* socket address.
* <p>
* If, if the address is {@code null}, creates an unbound socket.
*
* <p>If there is a security manager,
* its {@code checkListen} method is first called
* with the port from the socket address
* as its argument to ensure the operation is allowed.
* This could result in a SecurityException.
*
* @param bindaddr local socket address to bind, or {@code null}
* for an unbound socket.
*
* @throws SocketException if the socket could not be opened,
* or the socket could not bind to the specified local port.
* @throws SecurityException if a security manager exists and its
* {@code checkListen} method doesn't allow the operation.
* @see SecurityManager#checkListen
* @since 1.4
*/
// ▶ 1 构造UDP-Socket,并将其绑定到指定的Socket地址
public DatagramSocket(SocketAddress bindaddr) throws SocketException {
// 创建UDP-Socket和"UDP-Socket委托",并完成它们之间的双向引用
createImpl();
if(bindaddr == null) {
return;
}
try {
bind(bindaddr);
} finally {
if(!isBound()) {
close();
}
}
}
/**
* Constructs a datagram socket and binds it to any available port
* on the local host machine. The socket will be bound to the
* {@link InetAddress#isAnyLocalAddress wildcard} address,
* an IP address chosen by the kernel.
*
* <p>If there is a security manager,
* its {@code checkListen} method is first called
* with 0 as its argument to ensure the operation is allowed.
* This could result in a SecurityException.
*
* @throws SocketException if the socket could not be opened,
* or the socket could not bind to the specified local port.
* @throws SecurityException if a security manager exists and its
* {@code checkListen} method doesn't allow the operation.
* @see SecurityManager#checkListen
*/
// ▶ 1-1 构造UDP-Socket,并将其绑定到通配IP与随机端口
public DatagramSocket() throws SocketException {
this(new InetSocketAddress(0));
}
/**
* Creates a datagram socket, bound to the specified local
* address. The local port must be between 0 and 65535 inclusive.
* If the IP address is 0.0.0.0, the socket will be bound to the
* {@link InetAddress#isAnyLocalAddress wildcard} address,
* an IP address chosen by the kernel.
*
* <p>If there is a security manager,
* its {@code checkListen} method is first called
* with the {@code port} argument
* as its argument to ensure the operation is allowed.
* This could result in a SecurityException.
*
* @param port local port to use
* @param laddr local address to bind
*
* @throws SocketException if the socket could not be opened,
* or the socket could not bind to the specified local port.
* @throws SecurityException if a security manager exists and its
* {@code checkListen} method doesn't allow the operation.
* @see SecurityManager#checkListen
* @since 1.1
*/
// ▶ 1-2 构造UDP-Socket,并将其绑定到指定的IP和端口
public DatagramSocket(int port, InetAddress laddr) throws SocketException {
this(new InetSocketAddress(laddr, port));
}
/**
* Constructs a datagram socket and binds it to the specified port
* on the local host machine. The socket will be bound to the
* {@link InetAddress#isAnyLocalAddress wildcard} address,
* an IP address chosen by the kernel.
*
* <p>If there is a security manager,
* its {@code checkListen} method is first called
* with the {@code port} argument
* as its argument to ensure the operation is allowed.
* This could result in a SecurityException.
*
* @param port port to use.
*
* @throws SocketException if the socket could not be opened,
* or the socket could not bind to the specified local port.
* @throws SecurityException if a security manager exists and its
* {@code checkListen} method doesn't allow the operation.
* @see SecurityManager#checkListen
*/
// ▶ 1-2-1 构造UDP-Socket,并将其绑定到通配IP和指定的端口
public DatagramSocket(int port) throws SocketException {
this(port, null);
}
/**
* Creates an unbound datagram socket with the specified
* DatagramSocketImpl.
*
* @param impl an instance of a <B>DatagramSocketImpl</B>
* the subclass wishes to use on the DatagramSocket.
*
* @since 1.4
*/
// ▶ 2 构造一个未绑定的UDP-Socket,并显式指定"UDP-Socket委托"
protected DatagramSocket(DatagramSocketImpl impl) {
if(impl == null) {
throw new NullPointerException();
}
this.impl = impl;
checkOldImpl();
}
/*▲ 构造器 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ Socket操作 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Binds this DatagramSocket to a specific address and port.
* <p>
* If the address is {@code null}, then the system will pick up
* an ephemeral port and a valid local address to bind the socket.
*
* @param addr The address and port to bind to.
*
* @throws SocketException if any error happens during the bind, or if the
* socket is already bound.
* @throws SecurityException if a security manager exists and its
* {@code checkListen} method doesn't allow the operation.
* @throws IllegalArgumentException if addr is a SocketAddress subclass
* not supported by this socket.
* @since 1.4
*/
/*
* 对UDP-Socket执行【bind】操作。
*
* bindpoint: 待绑定的地址(ip+port)
*/
public synchronized void bind(SocketAddress bindpoint) throws SocketException {
if(isClosed()) {
throw new SocketException("Socket is closed");
}
// 禁止重复绑定
if(isBound()) {
throw new SocketException("already bound");
}
if(bindpoint == null) {
bindpoint = new InetSocketAddress(0);
}
if(!(bindpoint instanceof InetSocketAddress)) {
throw new IllegalArgumentException("Unsupported address type!");
}
InetSocketAddress epoint = (InetSocketAddress) bindpoint;
if(epoint.isUnresolved()) {
throw new SocketException("Unresolved address");
}
// 从Socket地址中解析出IP
InetAddress iaddr = epoint.getAddress();
// 从Socket地址中解析出端口
int port = epoint.getPort();
checkAddress(iaddr, "bind");
SecurityManager sec = System.getSecurityManager();
if(sec != null) {
sec.checkListen(port);
}
// 获取"UDP-Socket委托"
DatagramSocketImpl impl = getImpl();
try {
// 将当前UDP-Socket绑定到指定的IP和端口
impl.bind(port, iaddr);
} catch(SocketException e) {
impl.close();
throw e;
}
bound = true;
}
/**
* Connects the socket to a remote address for this socket. When a
* socket is connected to a remote address, packets may only be
* sent to or received from that address. By default a datagram
* socket is not connected.
*
* <p>If the remote destination to which the socket is connected does not
* exist, or is otherwise unreachable, and if an ICMP destination unreachable
* packet has been received for that address, then a subsequent call to
* send or receive may throw a PortUnreachableException. Note, there is no
* guarantee that the exception will be thrown.
*
* <p> If a security manager has been installed then it is invoked to check
* access to the remote address. Specifically, if the given {@code address}
* is a {@link InetAddress#isMulticastAddress multicast address},
* the security manager's {@link
* java.lang.SecurityManager#checkMulticast(InetAddress)
* checkMulticast} method is invoked with the given {@code address}.
* Otherwise, the security manager's {@link
* java.lang.SecurityManager#checkConnect(String, int) checkConnect}
* and {@link java.lang.SecurityManager#checkAccept checkAccept} methods
* are invoked, with the given {@code address} and {@code port}, to
* verify that datagrams are permitted to be sent and received
* respectively.
*
* <p> When a socket is connected, {@link #receive receive} and
* {@link #send send} <b>will not perform any security checks</b>
* on incoming and outgoing packets, other than matching the packet's
* and the socket's address and port. On a send operation, if the
* packet's address is set and the packet's address and the socket's
* address do not match, an {@code IllegalArgumentException} will be
* thrown. A socket connected to a multicast address may only be used
* to send packets.
*
* @param address the remote address for the socket
* @param port the remote port for the socket.
*
* @throws IllegalArgumentException if the address is null, or the port is out of range.
* @throws SecurityException if a security manager has been installed and it does
* not permit access to the given remote address
* @see #disconnect
*/
/*
* 对UDP-Socket执行【connect】操作。
*
* 将UDP-Socket连接到远程地址,之后只能向该远程地址发送数据,或从该远程地址接收数据。
*
* 注:这与TCP-Socket中的绑定意义完全不同,不会经过握手验证
*/
public void connect(InetAddress endpoint, int port) {
try {
// 通过"UDP-Socket委托"与远端建立连接
connectInternal(endpoint, port);
} catch(SocketException se) {
throw new Error("connect failed", se);
}
}
/**
* Connects this socket to a remote socket address (IP address + port number).
*
* <p> If given an {@link InetSocketAddress InetSocketAddress}, this method
* behaves as if invoking {@link #connect(InetAddress, int) connect(InetAddress,int)}
* with the given socket addresses IP address and port number.
*
* @param addr The remote address.
*
* @throws SocketException if the connect fails
* @throws IllegalArgumentException if {@code addr} is {@code null}, or {@code addr} is a SocketAddress
* subclass not supported by this socket
* @throws SecurityException if a security manager has been installed and it does
* not permit access to the given remote address
* @since 1.4
*/
/*
* 对UDP-Socket执行【connect】操作。
*
* 将UDP-Socket连接到远程地址,之后只能向该远程地址发送数据,或从该远程地址接收数据。
*
* 注:这与TCP-Socket中的绑定意义完全不同,不会经过握手验证
*/
public void connect(SocketAddress endpoint) throws SocketException {
if(endpoint == null) {
throw new IllegalArgumentException("Address can't be null");
}
if(!(endpoint instanceof InetSocketAddress)) {
throw new IllegalArgumentException("Unsupported address type");
}
InetSocketAddress epoint = (InetSocketAddress) endpoint;
if(epoint.isUnresolved()) {
throw new SocketException("Unresolved address");
}
// 通过"UDP-Socket委托"与远端建立连接
connectInternal(epoint.getAddress(), epoint.getPort());
}
/**
* Disconnects the socket. If the socket is closed or not connected,
* then this method has no effect.
*
* @see #connect
*/
/*
* 对UDP-Socket执行【disconnect】操作,即断开连接。
*/
public void disconnect() {
synchronized(this) {
if(isClosed()) {
return;
}
if(connectState == ST_CONNECTED) {
impl.disconnect();
}
connectedAddress = null;
connectedPort = -1;
connectState = ST_NOT_CONNECTED;
explicitFilter = false;
}
}
/*▲ Socket操作 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 数据传输 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Sends a datagram packet from this socket. The
* {@code DatagramPacket} includes information indicating the
* data to be sent, its length, the IP address of the remote host,
* and the port number on the remote host.
*
* <p>If there is a security manager, and the socket is not currently
* connected to a remote address, this method first performs some
* security checks. First, if {@code p.getAddress().isMulticastAddress()}
* is true, this method calls the
* security manager's {@code checkMulticast} method
* with {@code p.getAddress()} as its argument.
* If the evaluation of that expression is false,
* this method instead calls the security manager's
* {@code checkConnect} method with arguments
* {@code p.getAddress().getHostAddress()} and
* {@code p.getPort()}. Each call to a security manager method
* could result in a SecurityException if the operation is not allowed.
*
* @param p the {@code DatagramPacket} to be sent.
*
* @throws IOException if an I/O error occurs.
* @throws SecurityException if a security manager exists and its
* {@code checkMulticast} or {@code checkConnect}
* method doesn't allow the send.
* @throws PortUnreachableException may be thrown if the socket is connected
* to a currently unreachable destination. Note, there is no
* guarantee that the exception will be thrown.
* @throws java.nio.channels.IllegalBlockingModeException if this socket has an associated channel,
* and the channel is in non-blocking mode.
* @throws IllegalArgumentException if the socket is connected,
* and connected address and packet address differ.
* @revised 1.4
* @spec JSR-51
* @see java.net.DatagramPacket
* @see SecurityManager#checkMulticast(InetAddress)
* @see SecurityManager#checkConnect
*/
// 向远端(目的地)发送packet中存储的UDP数据包
public void send(DatagramPacket packet) throws IOException {
InetAddress packetAddress = null;
synchronized(packet) {
if(isClosed()) {
throw new SocketException("Socket is closed");
}
checkAddress(packet.getAddress(), "send");
// 如果UDP-Socket未建立连接,则需要先通过安全管理器检查远端地址
if(connectState == ST_NOT_CONNECTED) {
// check the address is ok wiht the security manager on every send.
SecurityManager security = System.getSecurityManager();
/*
* The reason you want to synchronize on datagram packet
* is because you don't want an applet to change the address
* while you are trying to send the packet for example
* after the security check but before the send.
*/
if(security != null) {
if(packet.getAddress().isMulticastAddress()) {
security.checkMulticast(packet.getAddress());
} else {
security.checkConnect(packet.getAddress().getHostAddress(), packet.getPort());
}
}
// UDP-Socket已与远端建立连接时,需要确保数据包中包含有效的目的地地址
} else {
// 获取远端IP(数据包将要被发送到的IP地址)
packetAddress = packet.getAddress();
if(packetAddress == null) {
packet.setAddress(connectedAddress);
packet.setPort(connectedPort);
} else if((!packetAddress.equals(connectedAddress)) || packet.getPort() != connectedPort) {
throw new IllegalArgumentException("connected address " + "and packet address" + " differ");
}
}
// 如果UDP-Socket还未完成绑定,则必须先将其绑定到本地地址
if(!isBound()) {
bind(new InetSocketAddress(0));
}
// 获取"UDP-Socket委托"
DatagramSocketImpl impl = getImpl();
// 向目的地发送UDP数据包,待发送的数据存储在packet中
impl.send(packet);
}
}
/**
* Receives a datagram packet from this socket. When this method
* returns, the {@code DatagramPacket}'s buffer is filled with
* the data received. The datagram packet also contains the sender's
* IP address, and the port number on the sender's machine.
* <p>
* This method blocks until a datagram is received. The
* {@code length} field of the datagram packet object contains
* the length of the received message. If the message is longer than
* the packet's length, the message is truncated.
* <p>
* If there is a security manager, a packet cannot be received if the
* security manager's {@code checkAccept} method
* does not allow it.
*
* @param p the {@code DatagramPacket} into which to place
* the incoming data.
*
* @throws IOException if an I/O error occurs.
* @throws SocketTimeoutException if setSoTimeout was previously called
* and the timeout has expired.
* @throws PortUnreachableException may be thrown if the socket is connected
* to a currently unreachable destination. Note, there is no guarantee that the
* exception will be thrown.
* @throws java.nio.channels.IllegalBlockingModeException if this socket has an associated channel,
* and the channel is in non-blocking mode.
* @revised 1.4
* @spec JSR-51
* @see java.net.DatagramPacket
* @see java.net.DatagramSocket
*/
// 从远端UDP-Socket接收UDP数据包并存入packet
public synchronized void receive(DatagramPacket packet) throws IOException {
synchronized(packet) {
if(!isBound()) {
bind(new InetSocketAddress(0));
}
// 获取"UDP-Socket委托"
DatagramSocketImpl impl = getImpl();
/*
* 如果已建立连接,则需要从固定的远端地址接收数据包,
* 那么在此之前,先丢掉那些地址信息与连接到的远端地址不匹配的那些数据包
*/
if(connectState == ST_NOT_CONNECTED) {
// 每次接收前,都需要通过安全管理员确认地址是否正确
SecurityManager security = System.getSecurityManager();
if(security != null) {
while(true) {
String peekAd = null;
int peekPort = 0;
// 查看远端积压的数据包,获取其IP和端口
if(!oldImpl) {
// We can use the new peekData() API
DatagramPacket peekPacket = new DatagramPacket(new byte[1], 1);
peekPort = impl.peekData(peekPacket);
peekAd = peekPacket.getAddress().getHostAddress();
} else {
InetAddress adr = new InetAddress();
peekPort = impl.peek(adr);
peekAd = adr.getHostAddress();
}
try {
// 校验远端数据包的IP和端口
security.checkAccept(peekAd, peekPort);
// 校验成功的情形下,结束循环,后续可以正常接收数据包了
break;
} catch(SecurityException se) {
// 校验失败的情形下,先消耗这个地址不匹配的数据包
DatagramPacket tmp = new DatagramPacket(new byte[1], 1);
impl.receive(tmp);
/*
* silently discard the offending packet and continue:
* unknown/malicious entities on nets should not make runtime throw security exception
* and disrupt the applet by sending random datagram packets.
*/
}
} // while
} // if
}
DatagramPacket tmp = null;
/*
* 如果需要模拟已连接状态,或者是需要显式过滤一批数据,
* 那么接下来仍然要对远端积压的数据包进行校验/过滤。
*/
if((connectState == ST_CONNECTED_NO_IMPL) || explicitFilter) {
/*
* We have to do the filtering the old fashioned way since the native impl doesn't support connect
* or the connect via the impl failed,
* or .. "explicitFilter" may be set when a socket is connected via the impl,
* for a period of time when packets from other sources might be queued on socket.
*/
while(true) {
InetAddress peekAddress = null;
int peekPort = -1;
// 查看远端积压的数据包,获取其IP和端口
if(!oldImpl) {
// We can use the new peekData() API
DatagramPacket peekPacket = new DatagramPacket(new byte[1], 1);
peekPort = impl.peekData(peekPacket);
peekAddress = peekPacket.getAddress();
} else {
// this api only works for IPv4
peekAddress = new InetAddress();
peekPort = impl.peek(peekAddress);
}
// 如果数据包的地址信息与连接到的远程地址信息是匹配的,说明这些数据包可信,直接放行
if((connectedAddress.equals(peekAddress)) && (connectedPort == peekPort)) {
break;
}
// 消耗这批不可信的数据包,相当于丢弃
tmp = new DatagramPacket(new byte[1024], 1024);
impl.receive(tmp);
// 在已经过滤掉packet数据包中的数据后,判断后续是否仍然需要继续过滤
if(explicitFilter && checkFiltering(tmp)) {
// 如果过滤完成,则不需要再过滤,直接退出循环即可
break;
}
} // while
} // if
/* If the security check succeeds, or the datagram is connected then receive the packet */
// 接收UDP数据包,接收到的数据存储到packet中
impl.receive(packet);
// 如果需要显式校验/过滤,且前面没有丢弃过数据,则需要在此尝试过滤
if(explicitFilter && tmp == null) {
// 注:这里的packet没有被过滤,但是会将其当成已过滤(丢弃)一样进行计数
checkFiltering(packet);
}
}
}
/*▲ 数据传输 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 关闭 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Closes this datagram socket.
* <p>
* Any thread currently blocked in {@link #receive} upon this socket
* will throw a {@link SocketException}.
*
* <p> If this socket has an associated channel then the channel is closed
* as well.
*
* @revised 1.4
* @spec JSR-51
*/
// 关闭UDP-Socket
public void close() {
synchronized(closeLock) {
if(isClosed()) {
return;
}
impl.close();
closed = true;
}
}
/*▲ 关闭 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 地址 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Returns the address of the endpoint this socket is bound to.
*
* @return a {@code SocketAddress} representing the local endpoint of this
* socket, or {@code null} if it is closed or not bound yet.
*
* @see #getLocalAddress()
* @see #getLocalPort()
* @see #bind(SocketAddress)
* @since 1.4
*/
// 返回当前UDP-Socket绑定的本地Socket地址
public SocketAddress getLocalSocketAddress() {
if(isClosed()) {
return null;
}
if(!isBound()) {
return null;
}
return new InetSocketAddress(getLocalAddress(), getLocalPort());
}
/**
* Gets the local address to which the socket is bound.
*
* <p>If there is a security manager, its
* {@code checkConnect} method is first called
* with the host address and {@code -1}
* as its arguments to see if the operation is allowed.
*
* @return the local address to which the socket is bound,
* {@code null} if the socket is closed, or
* an {@code InetAddress} representing
* {@link InetAddress#isAnyLocalAddress wildcard}
* address if either the socket is not bound, or
* the security manager {@code checkConnect}
* method does not allow the operation
*
* @see SecurityManager#checkConnect
* @since 1.1
*/
// 返回当前UDP-Socket绑定的本地IP
public InetAddress getLocalAddress() {
if(isClosed()) {
return null;
}
InetAddress in = null;
try {
// 获取"UDP-Socket委托"
DatagramSocketImpl impl = getImpl();
// 获取UDP-Socket绑定的本地IP
in = (InetAddress) impl.getOption(SocketOptions.SO_BINDADDR);
if(in.isAnyLocalAddress()) {
in = InetAddress.anyLocalAddress();
}
SecurityManager s = System.getSecurityManager();
if(s != null) {
s.checkConnect(in.getHostAddress(), -1);
}
} catch(Exception e) {
in = InetAddress.anyLocalAddress(); // "0.0.0.0"
}
return in;
}
/**
* Returns the port number on the local host to which this socket
* is bound.
*
* @return the port number on the local host to which this socket is bound,
* {@code -1} if the socket is closed, or
* {@code 0} if it is not bound yet.
*/
// 返回当前UDP-Socket绑定的本地端口
public int getLocalPort() {
if(isClosed()) {
return -1;
}
try {
// 获取"UDP-Socket委托"
DatagramSocketImpl impl = getImpl();
// 返回当前UDP-Socket绑定的本地端口
return impl.getLocalPort();
} catch(Exception e) {
return 0;
}
}
/**
* Returns the address of the endpoint this socket is connected to, or
* {@code null} if it is unconnected.
* <p>
* If the socket was connected prior to being {@link #close closed},
* then this method will continue to return the connected address
* after the socket is closed.
*
* @return a {@code SocketAddress} representing the remote
* endpoint of this socket, or {@code null} if it is
* not connected yet.
*
* @see #getInetAddress()
* @see #getPort()
* @see #connect(SocketAddress)
* @since 1.4
*/
// 返回当前UDP-Socket连接的远端Socket地址
public SocketAddress getRemoteSocketAddress() {
if(!isConnected()) {
return null;
}
return new InetSocketAddress(getInetAddress(), getPort());
}
/**
* Returns the address to which this socket is connected. Returns
* {@code null} if the socket is not connected.
* <p>
* If the socket was connected prior to being {@link #close closed},
* then this method will continue to return the connected address
* after the socket is closed.
*
* @return the address to which this socket is connected.
*/
// 返回当前UDP-Socket连接的远端IP
public InetAddress getInetAddress() {
return connectedAddress;
}
/**
* Returns the port number to which this socket is connected.
* Returns {@code -1} if the socket is not connected.
* <p>
* If the socket was connected prior to being {@link #close closed},
* then this method will continue to return the connected port number
* after the socket is closed.
*
* @return the port number to which this socket is connected.
*/
// 返回当前UDP-Socket连接的远端端口
public int getPort() {
return connectedPort;
}
/*▲ 地址 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 状态 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Returns the binding state of the socket.
* <p>
* If the socket was bound prior to being {@link #close closed},
* then this method will continue to return {@code true}
* after the socket is closed.
*
* @return true if the socket successfully bound to an address
*
* @since 1.4
*/
// 判断UDP-Socket是否已绑定
public boolean isBound() {
return bound;
}
/**
* Returns the connection state of the socket.
* <p>
* If the socket was connected prior to being {@link #close closed},
* then this method will continue to return {@code true}
* after the socket is closed.
*
* @return true if the socket successfully connected to a server
*
* @since 1.4
*/
// 判断UDP-Socket是否已连接
public boolean isConnected() {
return connectState != ST_NOT_CONNECTED;
}
/**
* Returns whether the socket is closed or not.
*
* @return true if the socket has been closed
*
* @since 1.4
*/
// 判断UDP-Socket是否已关闭
public boolean isClosed() {
synchronized(closeLock) {
return closed;
}
}
/*▲ 状态 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ Socket配置参数 ████████████████████████████████████████████████████████████████████████████████┓ */