New build.
This commit is contained in:
1 parent
a5a51f8aae
commit
b4ab5fb86a
835 files changed
+26499
-3119
No files matched your search
+128
-55
@@ -1,9 +1,9 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="generator" content="Doxygen 1.8.17"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>My Project: core::Socket Class Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
@@ -29,18 +29,21 @@
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<!-- Generated by Doxygen 1.8.17 -->
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
/* @license-end */
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
/* @license-end */</script>
|
||||
<div id="main-nav"></div>
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
@@ -79,19 +82,20 @@ Inheritance diagram for core::Socket:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><img src="classcore_1_1Socket__inherit__graph.png" border="0" usemap="#core_1_1Socket_inherit__map" alt="Inheritance graph"/></div>
|
||||
<map name="core_1_1Socket_inherit__map" id="core_1_1Socket_inherit__map">
|
||||
<area shape="rect" id="node3" href="classcore_1_1INotify.html" title="core::INotify" alt="" coords="18,155,113,181"/>
|
||||
<area shape="rect" id="node4" href="classcore_1_1TCPSocket.html" title="core::TCPSocket" alt="" coords="137,155,260,181"/>
|
||||
<area shape="rect" id="node12" href="classcore_1_1Timer.html" title="core::Timer" alt="" coords="284,155,372,181"/>
|
||||
<area shape="rect" id="node13" href="classcore_1_1UDPSocket.html" title="core::UDPSocket" alt="" coords="396,155,521,181"/>
|
||||
<area shape="rect" id="node2" href="classcore_1_1Object.html" title="core::Object" alt="" coords="216,5,309,32"/>
|
||||
<area shape="rect" id="node5" href="classcore_1_1TCPServer.html" title="core::TCPServer" alt="" coords="32,229,152,256"/>
|
||||
<area shape="rect" id="node8" href="classcore_1_1TCPSession.html" title="core::TCPSession" alt="" coords="179,229,309,256"/>
|
||||
<area shape="rect" id="node6" href="classcore_1_1TLSServer.html" title="core::TLSServer" alt="" coords="28,304,145,331"/>
|
||||
<area shape="rect" id="node7" href="classcore_1_1ConsoleServer.html" title="core::ConsoleServer" alt="" coords="5,379,147,405"/>
|
||||
<area shape="rect" id="node9" href="classcore_1_1TLSSession.html" title="core::TLSSession" alt="" coords="182,304,309,331"/>
|
||||
<area shape="rect" id="node10" href="classcore_1_1TerminalSession.html" title="core::TerminalSession" alt="" coords="171,379,323,405"/>
|
||||
<area shape="rect" id="node11" href="classcore_1_1ConsoleSession.html" title="core::ConsoleSession" alt="" coords="171,453,322,480"/>
|
||||
<area shape="rect" id="node14" href="classcore_1_1UDPServerSocket.html" title="core::UDPServerSocket" alt="" coords="377,229,540,256"/>
|
||||
<area shape="rect" title=" " alt="" coords="359,80,455,107"/>
|
||||
<area shape="rect" href="classcore_1_1INotify.html" title=" " alt="" coords="162,155,257,181"/>
|
||||
<area shape="rect" href="classcore_1_1TCPSocket.html" title=" " alt="" coords="281,155,404,181"/>
|
||||
<area shape="rect" href="classcore_1_1Timer.html" title=" " alt="" coords="428,155,516,181"/>
|
||||
<area shape="rect" href="classcore_1_1UDPSocket.html" title=" " alt="" coords="540,155,665,181"/>
|
||||
<area shape="rect" href="classcore_1_1Object.html" title=" " alt="" coords="360,5,453,32"/>
|
||||
<area shape="rect" href="classcore_1_1TCPServer.html" title=" " alt="" coords="169,229,289,256"/>
|
||||
<area shape="rect" href="classcore_1_1TCPSession.html" title=" " alt="" coords="323,229,453,256"/>
|
||||
<area shape="rect" href="classcore_1_1ConsoleServer.html" title=" " alt="" coords="5,304,147,331"/>
|
||||
<area shape="rect" href="classcore_1_1TLSServer.html" title=" " alt="" coords="171,304,288,331"/>
|
||||
<area shape="rect" href="classcore_1_1TerminalSession.html" title=" " alt="" coords="312,304,464,331"/>
|
||||
<area shape="rect" href="classcore_1_1TLSSession.html" title=" " alt="" coords="489,304,615,331"/>
|
||||
<area shape="rect" href="classcore_1_1ConsoleSession.html" title=" " alt="" coords="313,379,463,405"/>
|
||||
<area shape="rect" href="classcore_1_1UDPServerSocket.html" title=" " alt="" coords="521,229,684,256"/>
|
||||
</map>
|
||||
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
||||
<div class="dynheader">
|
||||
@@ -99,32 +103,32 @@ Collaboration diagram for core::Socket:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><img src="classcore_1_1Socket__coll__graph.png" border="0" usemap="#core_1_1Socket_coll__map" alt="Collaboration graph"/></div>
|
||||
<map name="core_1_1Socket_coll__map" id="core_1_1Socket_coll__map">
|
||||
<area shape="rect" id="node2" href="classcore_1_1Object.html" title="core::Object" alt="" coords="5,5,99,32"/>
|
||||
<area shape="rect" id="node4" href="classcore_1_1Command.html" title="core::Command" alt="" coords="73,81,188,108"/>
|
||||
<area shape="rect" id="node3" href="classcore_1_1EPoll.html" title="core::EPoll" alt="" coords="81,157,167,184"/>
|
||||
<area shape="rect" title=" " alt="" coords="9,247,105,273"/>
|
||||
<area shape="rect" href="classcore_1_1Object.html" title=" " alt="" coords="5,5,99,32"/>
|
||||
<area shape="rect" href="classcore_1_1Command.html" title=" " alt="" coords="73,81,188,108"/>
|
||||
<area shape="rect" href="classcore_1_1EPoll.html" title=" " alt="" coords="81,157,167,184"/>
|
||||
</map>
|
||||
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a0009f3813f6d64285f3dad602e4e01cf"><td class="memItemLeft" align="right" valign="top"><a id="a0009f3813f6d64285f3dad602e4e01cf"></a>
|
||||
 </td><td class="memItemRight" valign="bottom"><b>Socket</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &ePoll)</td></tr>
|
||||
<tr class="separator:a0009f3813f6d64285f3dad602e4e01cf"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a36f8a8fda1d79995228b52c2fa01873b"><td class="memItemLeft" align="right" valign="top"><a id="a36f8a8fda1d79995228b52c2fa01873b"></a>
|
||||
 </td><td class="memItemRight" valign="bottom"><b>Socket</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &ePoll, std::string text)</td></tr>
|
||||
<tr class="separator:a36f8a8fda1d79995228b52c2fa01873b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a4c3f87fd1de3c9eab4bf5efbb30ce87d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#a4c3f87fd1de3c9eab4bf5efbb30ce87d">Socket</a> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &ePoll, std::string text="")</td></tr>
|
||||
<tr class="separator:a4c3f87fd1de3c9eab4bf5efbb30ce87d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa5003845f8ae464ad2fa206176381be0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#aa5003845f8ae464ad2fa206176381be0">~Socket</a> ()</td></tr>
|
||||
<tr class="separator:aa5003845f8ae464ad2fa206176381be0"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:af2d1b6de7a64a9d446b0305b6ec47b31"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#af2d1b6de7a64a9d446b0305b6ec47b31">shutdown</a> (std::string text="unknown")</td></tr>
|
||||
<tr class="separator:af2d1b6de7a64a9d446b0305b6ec47b31"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac44f6ae3196a8a3e09a6a85fcf495762"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#ac44f6ae3196a8a3e09a6a85fcf495762">setDescriptor</a> (int descriptor)</td></tr>
|
||||
<tr class="memdesc:ac44f6ae3196a8a3e09a6a85fcf495762"><td class="mdescLeft"> </td><td class="mdescRight">Set the descriptor for the socket. <a href="#ac44f6ae3196a8a3e09a6a85fcf495762">More...</a><br /></td></tr>
|
||||
<tr class="memdesc:ac44f6ae3196a8a3e09a6a85fcf495762"><td class="mdescLeft"> </td><td class="mdescRight">Set the descriptor for the socket. <a href="classcore_1_1Socket.html#ac44f6ae3196a8a3e09a6a85fcf495762">More...</a><br /></td></tr>
|
||||
<tr class="separator:ac44f6ae3196a8a3e09a6a85fcf495762"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a06ba54744530439d4131e6aba4623d08"><td class="memItemLeft" align="right" valign="top"><a id="a06ba54744530439d4131e6aba4623d08"></a>
|
||||
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#a06ba54744530439d4131e6aba4623d08">getDescriptor</a> ()</td></tr>
|
||||
<tr class="memdesc:a06ba54744530439d4131e6aba4623d08"><td class="mdescLeft"> </td><td class="mdescRight">Get the descriptor for the socket. <br /></td></tr>
|
||||
<tr class="memdesc:a06ba54744530439d4131e6aba4623d08"><td class="mdescLeft"> </td><td class="mdescRight">Get the descriptor for the socket. <br />
|
||||
<br /></td></tr>
|
||||
<tr class="separator:a06ba54744530439d4131e6aba4623d08"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a4c9a3396693ff919eb827729f9e72b03"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#a4c9a3396693ff919eb827729f9e72b03">eventReceived</a> (struct epoll_event event)</td></tr>
|
||||
<tr class="memdesc:a4c9a3396693ff919eb827729f9e72b03"><td class="mdescLeft"> </td><td class="mdescRight">Parse epoll event and call specified callbacks. <a href="#a4c9a3396693ff919eb827729f9e72b03">More...</a><br /></td></tr>
|
||||
<tr class="separator:a4c9a3396693ff919eb827729f9e72b03"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aeee3b9d24b039679f1f05820209539c5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#aeee3b9d24b039679f1f05820209539c5">eventReceived</a> (struct epoll_event event, pid_t threadId)</td></tr>
|
||||
<tr class="memdesc:aeee3b9d24b039679f1f05820209539c5"><td class="mdescLeft"> </td><td class="mdescRight">Parse epoll event and call specified callbacks. <a href="classcore_1_1Socket.html#aeee3b9d24b039679f1f05820209539c5">More...</a><br /></td></tr>
|
||||
<tr class="separator:aeee3b9d24b039679f1f05820209539c5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a1413c826307ef0f29d7457770af675e3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#a1413c826307ef0f29d7457770af675e3">write</a> (std::string data)</td></tr>
|
||||
<tr class="separator:a1413c826307ef0f29d7457770af675e3"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a4855594af113428eacdaa7448d661121"><td class="memItemLeft" align="right" valign="top"><a id="a4855594af113428eacdaa7448d661121"></a>
|
||||
@@ -134,24 +138,24 @@ void </td><td class="memItemRight" valign="bottom"><b>write</b> (char *buff
|
||||
void </td><td class="memItemRight" valign="bottom"><b>output</b> (std::stringstream &out)</td></tr>
|
||||
<tr class="separator:ad67b0f95127bd987b98323120f40f6ed"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a81e5ee3e17834166d97c6e8b7dfe0da0"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#a81e5ee3e17834166d97c6e8b7dfe0da0">onRegister</a> ()</td></tr>
|
||||
<tr class="memdesc:a81e5ee3e17834166d97c6e8b7dfe0da0"><td class="mdescLeft"> </td><td class="mdescRight">Called when the socket has finished registering with the epoll processing. <a href="#a81e5ee3e17834166d97c6e8b7dfe0da0">More...</a><br /></td></tr>
|
||||
<tr class="memdesc:a81e5ee3e17834166d97c6e8b7dfe0da0"><td class="mdescLeft"> </td><td class="mdescRight">Called before the socket has registered with the epoll processing. <a href="classcore_1_1Socket.html#a81e5ee3e17834166d97c6e8b7dfe0da0">More...</a><br /></td></tr>
|
||||
<tr class="separator:a81e5ee3e17834166d97c6e8b7dfe0da0"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a23b9824653bbe4652a716acb828665b1"><td class="memItemLeft" align="right" valign="top"><a id="a23b9824653bbe4652a716acb828665b1"></a>
|
||||
virtual void </td><td class="memItemRight" valign="bottom"><b>onRegistered</b> ()</td></tr>
|
||||
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#a23b9824653bbe4652a716acb828665b1">onRegistered</a> ()</td></tr>
|
||||
<tr class="memdesc:a23b9824653bbe4652a716acb828665b1"><td class="mdescLeft"> </td><td class="mdescRight">Called after the socket has been registered with epoll processing. <br /></td></tr>
|
||||
<tr class="separator:a23b9824653bbe4652a716acb828665b1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa1d380db54a5b2efbc859e3744bd898b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#aa1d380db54a5b2efbc859e3744bd898b">onUnregister</a> ()</td></tr>
|
||||
<tr class="memdesc:aa1d380db54a5b2efbc859e3744bd898b"><td class="mdescLeft"> </td><td class="mdescRight">Called when the socket has finished unregistering for the epoll processing. <a href="#aa1d380db54a5b2efbc859e3744bd898b">More...</a><br /></td></tr>
|
||||
<tr class="memitem:aa1d380db54a5b2efbc859e3744bd898b"><td class="memItemLeft" align="right" valign="top"><a id="aa1d380db54a5b2efbc859e3744bd898b"></a>
|
||||
virtual void </td><td class="memItemRight" valign="bottom"><b>onUnregister</b> ()</td></tr>
|
||||
<tr class="separator:aa1d380db54a5b2efbc859e3744bd898b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ae9be59697c2b2e5efb19aaae3ba943d2"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#ae9be59697c2b2e5efb19aaae3ba943d2">onUnregistered</a> ()</td></tr>
|
||||
<tr class="memdesc:ae9be59697c2b2e5efb19aaae3ba943d2"><td class="mdescLeft"> </td><td class="mdescRight">Called when the socket has finished unregistering for the epoll processing. <a href="classcore_1_1Socket.html#ae9be59697c2b2e5efb19aaae3ba943d2">More...</a><br /></td></tr>
|
||||
<tr class="separator:ae9be59697c2b2e5efb19aaae3ba943d2"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a43247bfe43c2be5ab3863d9057d46b7c"><td class="memItemLeft" align="right" valign="top"><a id="a43247bfe43c2be5ab3863d9057d46b7c"></a>
|
||||
bool </td><td class="memItemRight" valign="bottom"><b>needsToWrite</b> ()</td></tr>
|
||||
<tr class="separator:a43247bfe43c2be5ab3863d9057d46b7c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
||||
Public Attributes</h2></td></tr>
|
||||
<tr class="memitem:a26ce6667b1d883e7a77fcd46ead03f6b"><td class="memItemLeft" ><a id="a26ce6667b1d883e7a77fcd46ead03f6b"></a>
|
||||
class {</td></tr>
|
||||
<tr class="memitem:a26ce6667b1d883e7a77fcd46ead03f6b"><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><b>bufferSize</b></td></tr>
|
||||
<tr class="separator:a26ce6667b1d883e7a77fcd46ead03f6b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:addc8b96547fb9cc921f9fb0e398d4882"><td class="memItemLeft" align="right" valign="top"><a id="addc8b96547fb9cc921f9fb0e398d4882"></a>
|
||||
bool </td><td class="memItemRight" valign="bottom"><b>active</b> = false</td></tr>
|
||||
<tr class="separator:addc8b96547fb9cc921f9fb0e398d4882"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
@@ -168,8 +172,11 @@ Protected Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a71c77a162698b9c074a7497beab7b5d8"><td class="memItemLeft" align="right" valign="top"><a id="a71c77a162698b9c074a7497beab7b5d8"></a>
|
||||
void </td><td class="memItemRight" valign="bottom"><b>setBufferSize</b> (int length)</td></tr>
|
||||
<tr class="separator:a71c77a162698b9c074a7497beab7b5d8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa9195676bb7ecbec167ecf5336921cbb"><td class="memItemLeft" align="right" valign="top"><a id="aa9195676bb7ecbec167ecf5336921cbb"></a>
|
||||
int </td><td class="memItemRight" valign="bottom"><b>getBufferSize</b> ()</td></tr>
|
||||
<tr class="separator:aa9195676bb7ecbec167ecf5336921cbb"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac8d6a2c54696eb6fc2024cf6bcf6b4e5"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#ac8d6a2c54696eb6fc2024cf6bcf6b4e5">onDataReceived</a> (std::string data)</td></tr>
|
||||
<tr class="memdesc:ac8d6a2c54696eb6fc2024cf6bcf6b4e5"><td class="mdescLeft"> </td><td class="mdescRight">Called when data is received from the socket. <a href="#ac8d6a2c54696eb6fc2024cf6bcf6b4e5">More...</a><br /></td></tr>
|
||||
<tr class="memdesc:ac8d6a2c54696eb6fc2024cf6bcf6b4e5"><td class="mdescLeft"> </td><td class="mdescRight">Called when data is received from the socket. <a href="classcore_1_1Socket.html#ac8d6a2c54696eb6fc2024cf6bcf6b4e5">More...</a><br /></td></tr>
|
||||
<tr class="separator:ac8d6a2c54696eb6fc2024cf6bcf6b4e5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:af6c06db2441633ae9979affe72930abc"><td class="memItemLeft" align="right" valign="top"><a id="af6c06db2441633ae9979affe72930abc"></a>
|
||||
virtual void </td><td class="memItemRight" valign="bottom"><b>onDataReceived</b> (char *buffer, int len)</td></tr>
|
||||
@@ -189,13 +196,69 @@ bool </td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p><a class="el" href="classcore_1_1Socket.html">Socket</a></p>
|
||||
<p>The core component to managing a socket.</p>
|
||||
<p>Hooks into the <a class="el" href="classcore_1_1EPoll.html">EPoll</a> through the registration and unregistration process and provides a communication socket of the specified protocol type. This object provides for all receiving data threading through use of the <a class="el" href="classcore_1_1EPoll.html">EPoll</a> object and also provides buffering for output data requests to the socket.</p>
|
||||
<p>A program using a socket object can request to open a socket (file or network or whatever) and communicate through the streambuffer interface of the socket object.</p>
|
||||
<p>The socket side of the <a class="el" href="classcore_1_1Socket.html">Socket</a> accepts EPOLLIN event and will maintain the data in a buffer for the stream readers to read. A onDataReceived event is then sent with the data received in the buffer that can be read through the stream.</p>
|
||||
<p>Hooks into the <a class="el" href="classcore_1_1EPoll.html">EPoll</a> through the registration and unregistration process and provides a communication socket of the specified protocol type. This object provides for all receiving data threading through use of the <a class="el" href="classcore_1_1EPoll.html">EPoll</a> object and also provides buffering for output data requests to the socket. <br />
|
||||
</p>
|
||||
<p>A program using a socket object can request to open a socket (network or device) and communicate through the streambuffer interface of the socket object.</p>
|
||||
<p>The socket side of the <a class="el" href="classcore_1_1Socket.html">Socket</a> accepts EPOLLIN event and will maintain the data in a buffer for the stream readers to read. A onDataReceived event is then sent with the data received in the buffer that can be read through the stream. Only sockets that send events to epoll can be used with this object.</p>
|
||||
<p>When writing to the stream the data is written into a buffer and a EPOLLOUT is scheduled. Upon receiving the EPOLLOUT event then the buffer is written to the socket output. </p>
|
||||
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a id="a4c9a3396693ff919eb827729f9e72b03"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a4c9a3396693ff919eb827729f9e72b03">◆ </a></span>eventReceived()</h2>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a id="a4c3f87fd1de3c9eab4bf5efbb30ce87d"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a4c3f87fd1de3c9eab4bf5efbb30ce87d">◆ </a></span>Socket()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">core::Socket::Socket </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="classcore_1_1EPoll.html">EPoll</a> & </td>
|
||||
<td class="paramname"><em>ePoll</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">std::string </td>
|
||||
<td class="paramname"><em>text</em> = <code>""</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Constructor</p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">ePoll</td><td>The <a class="el" href="classcore_1_1EPoll.html">EPoll</a> socket descriptor. </td></tr>
|
||||
<tr><td class="paramname">text</td><td>A title for this socket. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="aa5003845f8ae464ad2fa206176381be0"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#aa5003845f8ae464ad2fa206176381be0">◆ </a></span>~Socket()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">core::Socket::~Socket </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Destructor </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a id="aeee3b9d24b039679f1f05820209539c5"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#aeee3b9d24b039679f1f05820209539c5">◆ </a></span>eventReceived()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -204,8 +267,18 @@ bool </td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
|
||||
<td class="memname">bool core::Socket::eventReceived </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">struct epoll_event </td>
|
||||
<td class="paramname"><em>event</em></td><td>)</td>
|
||||
<td class="paramname"><em>event</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">pid_t </td>
|
||||
<td class="paramname"><em>threadId</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
@@ -276,15 +349,15 @@ bool </td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Called when the socket has finished registering with the epoll processing. </p>
|
||||
<p>Called before the socket has registered with the epoll processing. </p>
|
||||
<p>The onRegister method is called before the socket is registered with ePoll so objects extending the <a class="el" href="classcore_1_1Socket.html">Socket</a> definition can initialize the socket before receiving events. Evoked when the descriptor is set using setDescriptor for the socket. </p>
|
||||
|
||||
<p>Reimplemented in <a class="el" href="classcore_1_1TCPSession.html#a77600a18d75f1efee00b3dc626b1e98b">core::TCPSession</a>, and <a class="el" href="classcore_1_1TLSSession.html#a76cec7cf4851eb27abe77a2339344c6d">core::TLSSession</a>.</p>
|
||||
<p>Reimplemented in <a class="el" href="classcore_1_1TLSSession.html#a76cec7cf4851eb27abe77a2339344c6d">core::TLSSession</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="aa1d380db54a5b2efbc859e3744bd898b"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#aa1d380db54a5b2efbc859e3744bd898b">◆ </a></span>onUnregister()</h2>
|
||||
<a id="ae9be59697c2b2e5efb19aaae3ba943d2"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ae9be59697c2b2e5efb19aaae3ba943d2">◆ </a></span>onUnregistered()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -293,7 +366,7 @@ bool </td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void core::Socket::onUnregister </td>
|
||||
<td class="memname">void core::Socket::onUnregistered </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
@@ -307,7 +380,7 @@ bool </td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Called when the socket has finished unregistering for the epoll processing. </p>
|
||||
<p>The onUnregister method is called whenever the socket is unregistered with ePoll and socket communcation events will be stopped. The default method will close the socket and clean up the connection. If this is overridden by an extended object then the object should call this method to clean the socket up. </p>
|
||||
<p>The onUnregistered method is called whenever the socket is unregistered with ePoll and socket communcation events will be stopped. The default method will close the socket and clean up the connection. If this is overridden by an extended object then the object should call this method to clean the socket up. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -367,7 +440,7 @@ bool </td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Set the descriptor for the socket. </p>
|
||||
<p>setDescriptor establishes the file descriptor for the socket and registers the socket on the <a class="el" href="classcore_1_1EPoll.html">EPoll</a> controller. setDescriptor will invoke the <a class="el" href="classcore_1_1Socket.html#a81e5ee3e17834166d97c6e8b7dfe0da0" title="Called when the socket has finished registering with the epoll processing. ">onRegister()</a> event. </p>
|
||||
<p>setDescriptor establishes the file descriptor for the socket and registers the socket on the <a class="el" href="classcore_1_1EPoll.html">EPoll</a> controller. setDescriptor will invoke the <a class="el" href="classcore_1_1Socket.html#a81e5ee3e17834166d97c6e8b7dfe0da0" title="Called before the socket has registered with the epoll processing.">onRegister()</a> event. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -418,7 +491,7 @@ bool </td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</a> 1.8.17
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
Reference in new issue
Block a user