'\"
'\" Copyright (c) 1996 Sun Microsystems, Inc.
'\" Copyright (c) 1998-1999 by Scriptics Corporation.
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
'\" RCS: @(#) $Id: socket.n,v 1.2 2003/11/24 05:10:00 bbbush Exp $
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",
'\"	or "in/out" to describe whether procedure reads or modifies arg,
'\"	and indent is equivalent to second arg of .IP (shouldn't ever be
'\"	needed;  use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\"	Give maximum sizes of arguments for setting tab stops.  Type and
'\"	name are examples of largest possible arguments that will be passed
'\"	to .AP later.  If args are omitted, default tab stops are used.
'\"
'\" .BS
'\"	Start box enclosure.  From here until next .BE, everything will be
'\"	enclosed in one large box.
'\"
'\" .BE
'\"	End of box enclosure.
'\"
'\" .CS
'\"	Begin code excerpt.
'\"
'\" .CE
'\"	End code excerpt.
'\"
'\" .VS ?version? ?br?
'\"	Begin vertical sidebar, for use in marking newly-changed parts
'\"	of man pages.  The first argument is ignored and used for recording
'\"	the version when the .VS was added, so that the sidebars can be
'\"	found and removed when they reach a certain age.  If another argument
'\"	is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\"	End of vertical sidebar.
'\"
'\" .DS
'\"	Begin an indented unfilled display.
'\"
'\" .DE
'\"	End of indented unfilled display.
'\"
'\" .SO
'\"	Start of list of standard options for a Tk widget.  The
'\"	options follow on successive lines, in four columns separated
'\"	by tabs.
'\"
'\" .SE
'\"	End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\"	Start of description of a specific option.  cmdName gives the
'\"	option's name as specified in the class command, dbName gives
'\"	the option's name in the option database, and dbClass gives
'\"	the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\"	Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: socket.n,v 1.2 2003/11/24 05:10:00 bbbush Exp $
'\"
'\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
'\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1	\\fI\\$2\\fP	(\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
'\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
'\"	# BS - start boxed text
'\"	# ^y = starting y location
'\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
'\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
'\"	# VS - start vertical sidebar
'\"	# ^Y = starting y location
'\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
'\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
'\"	# Special macro to handle page bottom:  finish off current
'\"	# box/sidebar if in box/sidebar mode, then invoked standard
'\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
'\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
'\"	# DE - end display
.de DE
.fi
.RE
.sp
..
'\"	# SO - start of list of standard options
.de SO
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
'\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\fBoptions\\fR manual entry for details on the standard options.
..
'\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
'\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
'\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH socket 3tcl 8.0 Tcl "Tcl Built-In Commands"
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
socket \- 打開一個 TCP 網絡連接
.SH "總覽 SYNOPSIS"
.sp
\fBsocket \fR?\fIoptions\fR? \fIhost port\fR
.sp
\fBsocket\fR \fB\-server \fIcommand\fR ?\fIoptions\fR? \fIport\fR
.BE

.SH "描述 DESCRIPTION"
.PP
這個命令打開一個網絡套接口並返回將來可被 \fBread\fR、\fBputs\fR 和 \fBflush \fR命令調用使用一個通道標識符。目前只支持 TCP 網絡協議；將來的發行可能包括對補充協議的支持。依賴於是否指定了 \fB-server\fR 開關，可以使用 \fBsocket\fR 命令來打開客戶端或服務器端連接。

.SH "客戶端套接口 CLIENT SOCKETS"
.PP
如果未指定 \fB-server\fR 選項，則打開一個的連接的客戶端並且命令返回一個可被用於讀寫的通道標識符。 \fIPort\fR 和 \fIhost\fR 指定一個要連接到的端口；必須有一個服務器接受在這個端口上的連接。\fIPort\fR 是一個整數端口號而 \fIhost\fR 要麼是一個域名式樣的名字如 \fBwww.sunlabs.com\fR 要麼是一個數值 IP 地址如\fB127.0.0.1\fR。 使用 \fIlocalhost\fR 來參照在其上調用這個命令的那個主機。
.PP
在 \fIhost\fR 之前可以提供下列選項指定關於連接的補充信息:
.TP
\fB\-myaddr\fI addr\fR
\fIAddr\fR  給出用於連接的客戶端網絡接口的域名式樣的名字或數值  IP 地址。如果客戶端機器有多個網絡接口的話這個選項會有用處。如果省略了這個選項，則由系統軟件選擇客戶端接口。
.TP
\fB\-myport\fI port\fR
\fIPort\fR 指定用於連接的客戶端的一個整數端口號。如果省略了這個選項，則由系統軟件隨機的選擇客戶端口號。
.TP
\fB\-async\fR
\fB\-async\fR 選項將導致客戶端套接口被異步的連接。這意味着這個套接口將被立即建立，但在到\fBsocket\fR的調用返回的時候可能仍未連接到服務器上。在連接嘗試成功或失敗之前調用了   gets  或  flush 的時候，如果套接口在阻塞模式下，則將等待直到連接被完成或失敗。如果套接口在非阻塞模式之下，而在連接嘗試成功或失敗之前調用了 gets 或 flush ，則操作立即返回，並且在套接口上的 \fBfblocked\fR 返回 1。

.SH "服務器套接口 SERVER SOCKETS"
.PP
如果指定了 \fB-server\fR 選項，則新套接口將是用 \fIport \fR給出的端口的一個服務器。Tcl 將自動接受到這個給定端口的連接。對於每個連接 Tcl 將建立可以用來同客戶通信的一個新通道。Tcl 接着調用 \fIcommand\fR 並加上三個補充參數: 新通道的名字，用網絡地址表示的客戶的主機地址，和客戶的端口號。
.PP
在 \fIhost\fR 之前可以提供下列選項指定關於連接的補充信息:
.TP
\fB\-myaddr\fI addr\fR
 \fIAddr\fR 給出用於連接的服務器端網絡接口的域名式樣的名字或數值  IP 地址。如果服務器機器有多個網絡接口的話這個選項會有用處。如果省略了這個選項，則服務器套接口被綁定到特殊地址  INADDR_ANY 上，這樣它可以接受來自任何接口的連接。
.PP
服務器通道不能被用來輸入或輸出；它們唯一的用處是接受新的客戶連接。爲每個到來的客戶連接建立的通道是爲輸入和輸出而打開的。關閉服務器通道將關斷服務器，這樣就不能接受新連接了，不影響現存的連接。
.PP
服務器套接口依賴於 Tcl 事件機制來找出何時打開了新連接。如果應用未進入事件循環，例如通過調用 \fBvwait\fR 命令或調用 C 過程 \fBTcl_DoOneEvent\fR，則不接受連接。

.SH "配置選項 CONFIGURATION OPTIONS"
可以使用 \fBfconfigure\fR 命令來查詢套接口通道的許多隻讀配置選項:
.VS 8.0.5
.TP
\fB\-error\fR
這個選項得到給定套接口的當前錯誤狀態。在你需要確定一個異步連接操作是否成功的時候這個選項會有用處。如果有一個錯誤，則返回錯誤消息。如果沒有錯誤，則返回空串。
.VE 8.0.5
.TP
\fB\-sockname\fR
這個選項返回三個元素的一個列表，分別是這個套接口的地址、主機名和端口號。如果不能計算出這個主機名，第二個元素等同與列表的第一個元素地址。
.TP
\fB\-peername\fR
服務器套接口不支持這個選項。對於客戶和接受的套接口，這個選項返回三個元素的一個列表；它們是地址、主機名字和對等的套接口所連接或綁定到端口。如果不能計算出這個主機名，第二個元素等同與列表的第一個元素地址。
.PP

.SH "參見 SEE ALSO"
flush(n), open(n), read(n)

.SH "關鍵字 KEYWORDS"
bind, channel, connection, domain name, host, network address, socket, tcp

.SH "[中文版維護人]"
.B 寒蟬退士
.SH "[中文版最新更新]"
.B 2001/11/10
.SH "《中國 Linux 論壇 man 手冊頁翻譯計劃》:"
.BI http://cmpp.linuxforum.net
.SH "跋"
.br
本頁面中文版由中文 man 手冊頁計劃提供。
.br
中文 man 手冊頁計劃：\fBhttps://github.com/man-pages-zh/manpages-zh\fR