PageRenderTime 58ms CodeModel.GetById 15ms RepoModel.GetById 0ms app.codeStats 0ms

/.vim/manual/php/function.socket-get-option.html

https://github.com/urevic/dotfiles
HTML | 531 lines | 463 code | 68 blank | 0 comment | 0 complexity | 3db319c042ffdd338c7991b453627855 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <html>
    3. 

  3.  <head>
    4. 

  4.   <meta http-equiv="content-type" content="text/html; charset=UTF-8">
    5. 

  5.   <title>Gets socket options for the socket</title>
    6. 

  6. 

  7.  </head>
    8. 

  8.  <body><div class="manualnavbar" style="text-align: center;">
    9. 

  9.  <div class="prev" style="text-align: left; float: left;"><a href="function.socket-create.html">socket_create</a></div>
    10. 

  10.  <div class="next" style="text-align: right; float: right;"><a href="function.socket-getpeername.html">socket_getpeername</a></div>
    11. 

  11.  <div class="up"><a href="ref.sockets.html">Socket Functions</a></div>
    12. 

  12.  <div class="home"><a href="index.html">PHP Manual</a></div>
    13. 

  13. </div><hr /><div id="function.socket-get-option" class="refentry">
    14. 

  14.  <div class="refnamediv">
    15. 

  15.   <h1 class="refname">socket_get_option</h1>
    16. 

  16.   <p class="verinfo">(PHP 4 &gt;= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">socket_get_option</span> &mdash; <span class="dc-title">Gets socket options for the socket </span></p>
    17. 

  17. 

  18.  </div>
    19. 

  19.  
    20. 

  20.  <div class="refsect1 description" id="refsect1-function.socket-get-option-description">
    21. 

  21.   <h3 class="title">Description</h3>
    22. 

  22.   <div class="methodsynopsis dc-description">
    23. 

  23.    <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><b>socket_get_option</b></span>
    24. 

  24.     ( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$socket</tt></span>
    25. 

  25.    , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$level</tt></span>
    26. 

  26.    , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$optname</tt></span>
    27. 

  27.    )</div>
    28. 

  28. 

  29.   <p class="para rdfs-comment">
    30. 

  30.    The <span class="function"><b>socket_get_option()</b></span> function retrieves the value for
    31. 

  31.    the option specified by the <i><tt class="parameter">optname</tt></i> parameter for the
    32. 

  32.    specified <i><tt class="parameter">socket</tt></i>.
    33. 

  33.   </p>
    34. 

  34.  </div>
    35. 

  35. 

  36. 

  37.  <div class="refsect1 parameters" id="refsect1-function.socket-get-option-parameters">
    38. 

  38.   <h3 class="title">Parameters</h3>
    39. 

  39.   <p class="para">
    40. 

  40.    <dl>
    41. 

  41. 

  42.     <dt>
    43. 

  43. 

  44.      <span class="term"><i><tt class="parameter">socket</tt></i></span>
    45. 

  45.      <dd>
    46. 

  46. 

  47.       <p class="para">
    48. 

  48.        A valid socket resource created with <span class="function"><a href="function.socket-create.html" class="function">socket_create()</a></span>
    49. 

  49.        or <span class="function"><a href="function.socket-accept.html" class="function">socket_accept()</a></span>.
    50. 

  50.       </p>
    51. 

  51.      </dd>
    52. 

  52. 

  53.     </dt>
    54. 

  54. 

  55.     <dt>
    56. 

  56. 

  57.      <span class="term"><i><tt class="parameter">level</tt></i></span>
    58. 

  58.      <dd>
    59. 

  59. 

  60.       <p class="para">
    61. 

  61.        The <i><tt class="parameter">level</tt></i> parameter specifies the protocol
    62. 

  62.        level at which the option resides. For example, to retrieve options at
    63. 

  63.        the socket level, a <i><tt class="parameter">level</tt></i> parameter of
    64. 

  64.        <b><tt>SOL_SOCKET</tt></b> would be used. Other levels, such as
    65. 

  65.        <b><tt>TCP</tt></b>, can be used by
    66. 

  66.        specifying the protocol number of that level. Protocol numbers can be
    67. 

  67.        found by using the <span class="function"><a href="function.getprotobyname.html" class="function">getprotobyname()</a></span> function.
    68. 

  68.       </p>
    69. 

  69.      </dd>
    70. 

  70. 

  71.     </dt>
    72. 

  72. 

  73.     <dt>
    74. 

  74. 

  75.      <span class="term"><i><tt class="parameter">optname</tt></i></span>
    76. 

  76.      <dd>
    77. 

  77. 

  78.       <table class="doctable table">
    79. 

  79.        <caption><b>Available Socket Options</b></caption>
    80. 

  80.        
    81. 

  81.         <thead valign="middle">
    82. 

  82.          <tr valign="middle">
    83. 

  83.           <th>Option</th>
    84. 

  84.           <th>Description</th>
    85. 

  85.           <th>Type</th>
    86. 

  86.          </tr>
    87. 

  87. 

  88.         </thead>
    89. 

  89. 

  90.         <tbody valign="middle" class="tbody">
    91. 

  91.          <tr valign="middle">
    92. 

  92.           <td align="left"><b><tt>SO_DEBUG</tt></b></td>
    93. 

  93.           <td align="left">
    94. 

  94.            Reports whether debugging information is being recorded.
    95. 

  95.           </td>
    96. 

  96.           <td align="left">
    97. 

  97.            <span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
    98. 

  98.           </td>
    99. 

  99.          </tr>
    100. 

  100. 

  101.          <tr valign="middle">
    102. 

  102.           <td align="left"><b><tt>SO_BROADCAST</tt></b></td>
    103. 

  103.           <td align="left">
    104. 

  104.            Reports whether transmission of broadcast messages is supported.
    105. 

  105.           </td>
    106. 

  106.           <td align="left">
    107. 

  107.            <span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
    108. 

  108.           </td>
    109. 

  109.          </tr>
    110. 

  110. 

  111.          <tr valign="middle">
    112. 

  112.           <td align="left"><b><tt>SO_REUSEADDR</tt></b></td>
    113. 

  113.           <td align="left">
    114. 

  114.            Reports whether local addresses can be reused.
    115. 

  115.           </td>
    116. 

  116.           <td align="left">
    117. 

  117.            <span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
    118. 

  118.           </td>
    119. 

  119.          </tr>
    120. 

  120. 

  121.          <tr valign="middle">
    122. 

  122.           <td align="left"><b><tt>SO_KEEPALIVE</tt></b></td>
    123. 

  123.           <td align="left">
    124. 

  124.            Reports whether connections are kept active with periodic transmission
    125. 

  125.            of messages. If the connected socket fails to respond to these messages,
    126. 

  126.            the connection is broken and processes writing to that socket are notified
    127. 

  127.            with a SIGPIPE signal.
    128. 

  128.           </td>
    129. 

  129.           <td align="left">
    130. 

  130.            <span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
    131. 

  131.           </td>
    132. 

  132.          </tr>
    133. 

  133. 

  134.          <tr valign="middle">
    135. 

  135.           <td align="left"><b><tt>SO_LINGER</tt></b></td>
    136. 

  136.           <td align="left">
    137. 

  137.            <p class="para">
    138. 

  138.             Reports whether the <i><tt class="parameter">socket</tt></i> lingers on 
    139. 

  139.             <span class="function"><a href="function.socket-close.html" class="function">socket_close()</a></span> if data is present. By default, 
    140. 

  140.             when the socket is closed, it attempts to send all unsent data.
    141. 

  141.             In the case of a connection-oriented socket, 
    142. 

  142.             <span class="function"><a href="function.socket-close.html" class="function">socket_close()</a></span> will wait for its peer to
    143. 

  143.             acknowledge the data. 
    144. 

  144.            </p>
    145. 

  145.            <p class="para">
    146. 

  146.             If <var class="varname"><var class="varname">l_onoff</var></var> is non-zero and 
    147. 

  147.             <var class="varname"><var class="varname">l_linger</var></var> is zero, all the 
    148. 

  148.             unsent data will be discarded and RST (reset) is sent to the 
    149. 

  149.             peer in the case of a connection-oriented socket. 
    150. 

  150.            </p>
    151. 

  151.            <p class="para">
    152. 

  152.             On the other hand, if <var class="varname"><var class="varname">l_onoff</var></var> is 
    153. 

  153.             non-zero and <var class="varname"><var class="varname">l_linger</var></var> is non-zero,
    154. 

  154.             <span class="function"><a href="function.socket-close.html" class="function">socket_close()</a></span> will block until all the data 
    155. 

  155.             is sent or the time specified in <var class="varname"><var class="varname">l_linger</var></var>
    156. 

  156.             elapses. If the socket is non-blocking, 
    157. 

  157.             <span class="function"><a href="function.socket-close.html" class="function">socket_close()</a></span> will fail and return an error.
    158. 

  158.            </p>
    159. 

  159.           </td>
    160. 

  160.           <td align="left">
    161. 

  161.            <span class="type"><a href="language.types.array.html" class="type array">array</a></span>. The array will contain two keys:
    162. 

  162.            <var class="varname"><var class="varname">l_onoff</var></var> and 
    163. 

  163.            <var class="varname"><var class="varname">l_linger</var></var>. 
    164. 

  164.           </td>
    165. 

  165.          </tr>
    166. 

  166. 

  167.          <tr valign="middle">
    168. 

  168.           <td align="left"><b><tt>SO_OOBINLINE</tt></b></td>
    169. 

  169.           <td align="left">
    170. 

  170.            Reports whether the <i><tt class="parameter">socket</tt></i> leaves out-of-band data inline.
    171. 

  171.           </td>
    172. 

  172.           <td align="left">
    173. 

  173.            <span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
    174. 

  174.           </td>
    175. 

  175.          </tr>
    176. 

  176. 

  177.          <tr valign="middle">
    178. 

  178.           <td align="left"><b><tt>SO_SNDBUF</tt></b></td>
    179. 

  179.           <td align="left">
    180. 

  180.            Reports the size of the send buffer.
    181. 

  181.           </td>
    182. 

  182.           <td align="left">
    183. 

  183.            <span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
    184. 

  184.           </td>          
    185. 

  185.          </tr>
    186. 

  186. 

  187.          <tr valign="middle">
    188. 

  188.           <td align="left"><b><tt>SO_RCVBUF</tt></b></td>
    189. 

  189.           <td align="left">
    190. 

  190.            Reports the size of the receive buffer.
    191. 

  191.           </td>
    192. 

  192.           <td align="left">
    193. 

  193.            <span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
    194. 

  194.           </td>         
    195. 

  195.          </tr>
    196. 

  196. 

  197.          <tr valign="middle">
    198. 

  198.           <td align="left"><b><tt>SO_ERROR</tt></b></td>
    199. 

  199.           <td align="left">
    200. 

  200.            Reports information about error status and clears it.
    201. 

  201.           </td>
    202. 

  202.           <td align="left">
    203. 

  203.            <span class="type"><a href="language.types.integer.html" class="type int">int</a></span> (cannot be set by <span class="function"><a href="function.socket-set-option.html" class="function">socket_set_option()</a></span>)
    204. 

  204.           </td>
    205. 

  205.          </tr>
    206. 

  206. 

  207.          <tr valign="middle">
    208. 

  208.           <td align="left"><b><tt>SO_TYPE</tt></b></td>
    209. 

  209.           <td align="left">
    210. 

  210.            Reports the <i><tt class="parameter">socket</tt></i> type (e.g. 
    211. 

  211.            <b><tt>SOCK_STREAM</tt></b>).
    212. 

  212.           </td>
    213. 

  213.           <td align="left">
    214. 

  214.            <span class="type"><a href="language.types.integer.html" class="type int">int</a></span> (cannot be set by <span class="function"><a href="function.socket-set-option.html" class="function">socket_set_option()</a></span>)
    215. 

  215.           </td>
    216. 

  216.          </tr>
    217. 

  217. 

  218.          <tr valign="middle">
    219. 

  219.           <td align="left"><b><tt>SO_DONTROUTE</tt></b></td>
    220. 

  220.           <td align="left">
    221. 

  221.            Reports whether outgoing messages bypass the standard routing facilities.
    222. 

  222.           </td>
    223. 

  223.           <td align="left">
    224. 

  224.            <span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
    225. 

  225.           </td>
    226. 

  226.          </tr>
    227. 

  227. 

  228.          <tr valign="middle">
    229. 

  229.           <td align="left"><b><tt>SO_RCVLOWAT</tt></b></td>
    230. 

  230.           <td align="left">
    231. 

  231.            Reports the minimum number of bytes to process for <i><tt class="parameter">socket</tt></i> 
    232. 

  232.            input operations.
    233. 

  233.           </td>
    234. 

  234.           <td align="left">
    235. 

  235.            <span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
    236. 

  236.           </td>
    237. 

  237.          </tr>
    238. 

  238. 

  239.          <tr valign="middle">
    240. 

  240.           <td align="left"><b><tt>SO_RCVTIMEO</tt></b></td>
    241. 

  241.           <td align="left">
    242. 

  242.            Reports the timeout value for input operations.
    243. 

  243.           </td>
    244. 

  244.           <td align="left">
    245. 

  245.            <span class="type"><a href="language.types.array.html" class="type array">array</a></span>. The array will contain two keys:
    246. 

  246.            <var class="varname"><var class="varname">sec</var></var> which is the seconds part on the timeout
    247. 

  247.            value and <var class="varname"><var class="varname">usec</var></var> which is the microsecond part 
    248. 

  248.            of the timeout value. 
    249. 

  249.           </td>
    250. 

  250.          </tr>
    251. 

  251. 

  252.          <tr valign="middle">
    253. 

  253.           <td align="left"><b><tt>SO_SNDTIMEO</tt></b></td>
    254. 

  254.           <td align="left">
    255. 

  255.            Reports the timeout value specifying the amount of time that an output
    256. 

  256.            function blocks because flow control prevents data from being sent.
    257. 

  257.           </td>
    258. 

  258.           <td align="left">
    259. 

  259.            <span class="type"><a href="language.types.array.html" class="type array">array</a></span>. The array will contain two keys:
    260. 

  260.            <var class="varname"><var class="varname">sec</var></var> which is the seconds part on the timeout
    261. 

  261.            value and <var class="varname"><var class="varname">usec</var></var> which is the microsecond part 
    262. 

  262.            of the timeout value. 
    263. 

  263.           </td>
    264. 

  264.          </tr>
    265. 

  265. 

  266.          <tr valign="middle">
    267. 

  267.           <td align="left"><b><tt>SO_SNDLOWAT</tt></b></td>
    268. 

  268.           <td align="left">
    269. 

  269.            Reports the minimum number of bytes to process for <i><tt class="parameter">socket</tt></i> output operations.
    270. 

  270.           </td>
    271. 

  271.           <td align="left">
    272. 

  272.            <span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
    273. 

  273.           </td>
    274. 

  274.          </tr>
    275. 

  275. 

  276.          <tr valign="middle">
    277. 

  277.           <td align="left"><b><tt>TCP_NODELAY</tt></b></td>
    278. 

  278.           <td align="left">
    279. 

  279.            Reports whether the Nagle TCP algorithm is disabled.
    280. 

  280.           </td>
    281. 

  281.           <td align="left">
    282. 

  282.            <span class="type"><a href="language.types.integer.html" class="type int">int</a></span>
    283. 

  283.           </td>
    284. 

  284.          </tr>
    285. 

  285. 

  286.          <tr valign="middle">
    287. 

  287.           <td align="left"><b><tt>MCAST_JOIN_GROUP</tt></b></td>
    288. 

  288.           <td align="left">
    289. 

  289.            Joins a multicast group. (added in PHP 5.4)
    290. 

  290.           </td>
    291. 

  291.           <td align="left">
    292. 

  292.            <span class="type"><a href="language.types.array.html" class="type array">array</a></span> with keys <i>&quot;group&quot;</i>, specifying
    293. 

  293.            a <span class="type"><a href="language.types.string.html" class="type string">string</a></span> with an IPv4 or IPv6 multicast address and
    294. 

  294.            <i>&quot;interface&quot;</i>, specifying either an interface
    295. 

  295.            number (type <span class="type"><a href="language.types.integer.html" class="type int">int</a></span>) or a <i>string</i> with
    296. 

  296.            the interface name, like <i>&quot;eth0&quot;</i>.
    297. 

  297.            <i>0</i> can be specified to indicate the interface
    298. 

  298.            should be selected using routing rules. (can only be used in
    299. 

  299.            <span class="function"><a href="function.socket-set-option.html" class="function">socket_set_option()</a></span>)
    300. 

  300.           </td>
    301. 

  301.          </tr>
    302. 

  302. 

  303.          <tr valign="middle">
    304. 

  304.           <td align="left"><b><tt>MCAST_LEAVE_GROUP</tt></b></td>
    305. 

  305.           <td align="left">
    306. 

  306.            Leaves a multicast group. (added in PHP 5.4)
    307. 

  307.           </td>
    308. 

  308.           <td align="left">
    309. 

  309.            <span class="type"><a href="language.types.array.html" class="type array">array</a></span>. See <b><tt>MCAST_JOIN_GROUP</tt></b> for
    310. 

  310.            more information. (can only be used in
    311. 

  311.            <span class="function"><a href="function.socket-set-option.html" class="function">socket_set_option()</a></span>)
    312. 

  312.           </td>
    313. 

  313.          </tr>
    314. 

  314. 

  315.          <tr valign="middle">
    316. 

  316.           <td align="left"><b><tt>MCAST_BLOCK_SOURCE</tt></b></td>
    317. 

  317.           <td align="left">
    318. 

  318.            Blocks packets arriving from a specific source to a specific
    319. 

  319.            multicast group, which must have been previously joined.
    320. 

  320.            (added in PHP 5.4)
    321. 

  321.           </td>
    322. 

  322.           <td align="left">
    323. 

  323.            <span class="type"><a href="language.types.array.html" class="type array">array</a></span> with the same keys as
    324. 

  324.            <b><tt>MCAST_JOIN_GROUP</tt></b>, plus one extra key,
    325. 

  325.            <i>source</i>, which maps to a <span class="type"><a href="language.types.string.html" class="type string">string</a></span>
    326. 

  326.            specifying an IPv4 or IPv6 address of the source to be blocked.
    327. 

  327.            (can only be used in <span class="function"><a href="function.socket-set-option.html" class="function">socket_set_option()</a></span>)
    328. 

  328.           </td>
    329. 

  329.          </tr>
    330. 

  330. 

  331.          <tr valign="middle">
    332. 

  332.           <td align="left"><b><tt>MCAST_UNBLOCK_SOURCE</tt></b></td>
    333. 

  333.           <td align="left">
    334. 

  334.            Unblocks (start receiving again) packets arriving from a specific
    335. 

  335.            source address to a specific multicast group, which must have been
    336. 

  336.            previously joined. (added in PHP 5.4)
    337. 

  337.           </td>
    338. 

  338.           <td align="left">
    339. 

  339.            <span class="type"><a href="language.types.array.html" class="type array">array</a></span> with the same format as
    340. 

  340.            <b><tt>MCAST_BLOCK_SOURCE</tt></b>.
    341. 

  341.            (can only be used in <span class="function"><a href="function.socket-set-option.html" class="function">socket_set_option()</a></span>)
    342. 

  342.           </td>
    343. 

  343.          </tr>
    344. 

  344. 

  345.          <tr valign="middle">
    346. 

  346.           <td align="left"><b><tt>MCAST_JOIN_SOURCE_GROUP</tt></b></td>
    347. 

  347.           <td align="left">
    348. 

  348.            Receive packets destined to a specific multicast group whose source
    349. 

  349.            address matches a specific value. (added in PHP 5.4)
    350. 

  350.           </td>
    351. 

  351.           <td align="left">
    352. 

  352.            <span class="type"><a href="language.types.array.html" class="type array">array</a></span> with the same format as
    353. 

  353.            <b><tt>MCAST_BLOCK_SOURCE</tt></b>.
    354. 

  354.            (can only be used in <span class="function"><a href="function.socket-set-option.html" class="function">socket_set_option()</a></span>)
    355. 

  355.           </td>
    356. 

  356.          </tr>
    357. 

  357. 

  358.          <tr valign="middle">
    359. 

  359.           <td align="left"><b><tt>MCAST_LEAVE_SOURCE_GROUP</tt></b></td>
    360. 

  360.           <td align="left">
    361. 

  361.            Stop receiving packets destined to a specific multicast group whose
    362. 

  362.            soure address matches a specific value. (added in PHP 5.4)
    363. 

  363.           </td>
    364. 

  364.           <td align="left">
    365. 

  365.            <span class="type"><a href="language.types.array.html" class="type array">array</a></span> with the same format as
    366. 

  366.            <b><tt>MCAST_BLOCK_SOURCE</tt></b>.
    367. 

  367.            (can only be used in <span class="function"><a href="function.socket-set-option.html" class="function">socket_set_option()</a></span>)
    368. 

  368.           </td>
    369. 

  369.          </tr>
    370. 

  370. 

  371.          <tr valign="middle">
    372. 

  372.           <td align="left"><b><tt>IP_MULTICAST_IF</tt></b></td>
    373. 

  373.           <td align="left">
    374. 

  374.            The outgoing interface for IPv4 multicast packets.
    375. 

  375.            (added in PHP 5.4)
    376. 

  376.           </td>
    377. 

  377.           <td align="left">
    378. 

  378.            Either <span class="type"><a href="language.types.integer.html" class="type int">int</a></span> specifying the interface number or a
    379. 

  379.            <span class="type"><a href="language.types.string.html" class="type string">string</a></span> with an interface name, like
    380. 

  380.            <i>eth0</i>. The value <span class="type"><span class="type 0">0</span></span> can be used to
    381. 

  381.            indicate the routing table is to used in the interface selection.
    382. 

  382.            The function <span class="function"><b>socket_get_option()</b></span> returns an
    383. 

  383.            interface index.
    384. 

  384.            Note that, unlike the C API, this option does NOT take an IP
    385. 

  385.            address. This eliminates the interface difference between
    386. 

  386.            <b><tt>IP_MULTICAST_IF</tt></b> and
    387. 

  387.            <b><tt>IPV6_MULTICAST_IF</tt></b>.
    388. 

  388.           </td>
    389. 

  389.          </tr>
    390. 

  390. 

  391.          <tr valign="middle">
    392. 

  392.           <td align="left"><b><tt>IPV6_MULTICAST_IF</tt></b></td>
    393. 

  393.           <td align="left">
    394. 

  394.            The outgoing interface for IPv6 multicast packets.
    395. 

  395.            (added in PHP 5.4)
    396. 

  396.           </td>
    397. 

  397.           <td align="left">
    398. 

  398.            The same as <b><tt>IP_MULTICAST_IF</tt></b>.
    399. 

  399.           </td>
    400. 

  400.          </tr>
    401. 

  401. 

  402.          <tr valign="middle">
    403. 

  403.           <td align="left"><b><tt>IP_MULTICAST_LOOP</tt></b></td>
    404. 

  404.           <td align="left">
    405. 

  405.            The multicast loopback policy for IPv4 packets, which
    406. 

  406.            determines whether multicast packets sent by this socket also reach
    407. 

  407.            receivers in the same host that have joined the same multicast group
    408. 

  408.            on the outgoing interface used by this socket. This is the case by
    409. 

  409.            default.
    410. 

  410.            (added in PHP 5.4)
    411. 

  411.           </td>
    412. 

  412.           <td align="left">
    413. 

  413.            <span class="type"><a href="language.types.integer.html" class="type int">int</a></span> (either <i>0</i> or
    414. 

  414.            <i>1</i>). For <span class="function"><a href="function.socket-set-option.html" class="function">socket_set_option()</a></span>
    415. 

  415.            any value will be accepted and will be converted to a boolean
    416. 

  416.            following the usual PHP rules.
    417. 

  417.           </td>
    418. 

  418.          </tr>
    419. 

  419. 

  420.          <tr valign="middle">
    421. 

  421.           <td align="left"><b><tt>IPV6_MULTICAST_LOOP</tt></b></td>
    422. 

  422.           <td align="left">
    423. 

  423.            Analogous to <b><tt>IP_MULTICAST_LOOP</tt></b>, but for IPv6.
    424. 

  424.            (added in PHP 5.4)
    425. 

  425.           </td>
    426. 

  426.           <td align="left">
    427. 

  427.            <span class="type"><a href="language.types.integer.html" class="type int">int</a></span>. See <b><tt>IP_MULTICAST_LOOP</tt></b>.
    428. 

  428.           </td>
    429. 

  429.          </tr>
    430. 

  430. 

  431.          <tr valign="middle">
    432. 

  432.           <td align="left"><b><tt>IP_MULTICAST_TTL</tt></b></td>
    433. 

  433.           <td align="left">
    434. 

  434.            The time-to-live of outgoing IPv4 multicast packets. This should be
    435. 

  435.            a value between 0 (don&#039;t leave the interface) and 255. The default
    436. 

  436.            value is 1 (only the local network is reached).
    437. 

  437.            (added in PHP 5.4)
    438. 

  438.           </td>
    439. 

  439.           <td align="left">
    440. 

  440.            <span class="type"><a href="language.types.integer.html" class="type int">int</a></span> between 0 and 255.
    441. 

  441.           </td>
    442. 

  442.          </tr>
    443. 

  443. 

  444.          <tr valign="middle">
    445. 

  445.           <td align="left"><b><tt>IPV6_MULTICAST_HOPS</tt></b></td>
    446. 

  446.           <td align="left">
    447. 

  447.            Analogous to <b><tt>IP_MULTICAST_TTL</tt></b>, but for IPv6
    448. 

  448.            packets. The value -1 is also accepted, meaning the route default
    449. 

  449.            should be used.
    450. 

  450.            (added in PHP 5.4)
    451. 

  451.           </td>
    452. 

  452.           <td align="left">
    453. 

  453.            <span class="type"><a href="language.types.integer.html" class="type int">int</a></span> between -1 and 255.
    454. 

  454.           </td>
    455. 

  455.          </tr>
    456. 

  456. 

  457.         </tbody>
    458. 

  458.        
    459. 

  459.       </table>
    460. 

  460. 

  461.      </dd>
    462. 

  462. 

  463.     </dt>
    464. 

  464. 

  465.    </dl>
    466. 

  466. 

  467.   </p>
    468. 

  468.  </div>
    469. 

  469. 

  470. 

  471.  <div class="refsect1 returnvalues" id="refsect1-function.socket-get-option-returnvalues">
    472. 

  472.   <h3 class="title">Return Values</h3>
    473. 

  473.   <p class="para">
    474. 

  474.    Returns the value of the given option, or <b><tt>FALSE</tt></b> on errors.
    475. 

  475.   </p>
    476. 

  476.  </div>
    477. 

  477. 

  478. 

  479.  <div class="refsect1 examples" id="refsect1-function.socket-get-option-examples">
    480. 

  480.   <h3 class="title">Examples</h3>
    481. 

  481.   <p class="para">
    482. 

  482.    <div class="example" id="example-4081">
    483. 

  483.     <p><b>Example #1 <span class="function"><a href="function.socket-set-option.html" class="function">socket_set_option()</a></span> example</b></p>
    484. 

  484.     <div class="example-contents">
    485. 

  485. <div class="phpcode"><code><span style="color: #000000">
    486. 

  486. <span style="color: #0000BB">&lt;?php<br />$socket&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">socket_create_listen</span><span style="color: #007700">(</span><span style="color: #0000BB">1223</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$linger&nbsp;</span><span style="color: #007700">=&nbsp;array(</span><span style="color: #DD0000">'l_linger'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #0000BB">1</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'l_onoff'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">socket_set_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">SOL_SOCKET</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">SO_LINGER</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$linger</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">socket_get_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">SOL_SOCKET</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">SO_REUSEADDR</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?&gt;</span>
    487. 

  487. </span>
    488. 

  488. </code></div>
    489. 

  489.     </div>
    490. 

  490. 

  491.    </div>
    492. 

  492.   </p>
    493. 

  493.  </div>
    494. 

  494. 

  495. 

  496.  <div class="refsect1 changelog" id="refsect1-function.socket-get-option-changelog">
    497. 

  497.   <h3 class="title">Changelog</h3>
    498. 

  498.   <p class="para">
    499. 

  499.    <table class="doctable informaltable">
    500. 

  500.     
    501. 

  501.      <thead valign="middle">
    502. 

  502.       <tr valign="middle">
    503. 

  503.        <th>Version</th>
    504. 

  504.        <th>Description</th>
    505. 

  505.       </tr>
    506. 

  506. 

  507.      </thead>
    508. 

  508. 

  509.      <tbody valign="middle" class="tbody">
    510. 

  510.       <tr valign="middle">
    511. 

  511.        <td align="left">4.3.0</td>
    512. 

  512.        <td align="left">
    513. 

  513.         The name of this function was changed. It used to be called
    514. 

  514.         <i>socket_getopt()</i>.
    515. 

  515.        </td>
    516. 

  516.       </tr>
    517. 

  517. 

  518.      </tbody>
    519. 

  519.     
    520. 

  520.    </table>
    521. 

  521. 

  522.   </p>
    523. 

  523.  </div>
    524. 

  524. 

  525. 

  526. </div><hr /><div class="manualnavbar" style="text-align: center;">
    527. 

  527.  <div class="prev" style="text-align: left; float: left;"><a href="function.socket-create.html">socket_create</a></div>
    528. 

  528.  <div class="next" style="text-align: right; float: right;"><a href="function.socket-getpeername.html">socket_getpeername</a></div>
    529. 

  529.  <div class="up"><a href="ref.sockets.html">Socket Functions</a></div>
    530. 

  530.  <div class="home"><a href="index.html">PHP Manual</a></div>
    531. 

  531. </div></body></html>
    532. 

  532.