277 lines
31 KiB
HTML
277 lines
31 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
|
|
<title>wxLua: /mnt/share/devel/lua/wxLua/modules/wxluasocket/include/wxlsock.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<!-- Generated by Doxygen 1.6.3 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="main.html"><span>Main Page</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li><a href="dirs.html"><span>Directories</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="navpath"><a class="el" href="dir_15d5a205ad383328522db6a6be296af1.html">modules</a> » <a class="el" href="dir_7cd3065828d87458b0d7ef005e985a57.html">wxluasocket</a> » <a class="el" href="dir_a857424e6167482505b0cee7befbe354.html">include</a>
|
|
</div>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>wxlsock.h</h1><a href="wxlsock_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/////////////////////////////////////////////////////////////////////////////</span>
|
|
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">// Name: wxlsock.h</span>
|
|
<a name="l00003"></a>00003 <span class="comment">// Purpose: wxLua Socket interfaces</span>
|
|
<a name="l00004"></a>00004 <span class="comment">// Author: J. Winwood, John Labenski, Ray Gilbert</span>
|
|
<a name="l00005"></a>00005 <span class="comment">// Created: March 2002</span>
|
|
<a name="l00006"></a>00006 <span class="comment">// Copyright: (c) 2002 Lomtick Software. All rights reserved.</span>
|
|
<a name="l00007"></a>00007 <span class="comment">// Licence: wxWidgets licence.</span><span class="comment"></span>
|
|
<a name="l00008"></a>00008 <span class="comment">/////////////////////////////////////////////////////////////////////////////</span>
|
|
<a name="l00009"></a>00009 <span class="comment"></span>
|
|
<a name="l00010"></a>00010 <span class="preprocessor">#ifndef WX_LUA_SOCKET_H_</span>
|
|
<a name="l00011"></a>00011 <span class="preprocessor"></span><span class="preprocessor">#define WX_LUA_SOCKET_H_</span>
|
|
<a name="l00012"></a>00012 <span class="preprocessor"></span>
|
|
<a name="l00013"></a>00013 <span class="preprocessor">#include "<a class="code" href="wxluasocketdefs_8h.html">wxluasocket/include/wxluasocketdefs.h</a>"</span>
|
|
<a name="l00014"></a>00014
|
|
<a name="l00015"></a><a class="code" href="wxlsock_8h.html#a1fdd8670657fe9588ba3e185a3ecc69a">00015</a> <span class="keyword">class </span><a class="code" href="wxluadebugdefs_8h.html#a26bb867eefeede0ae330a79109b67d2b">WXDLLIMPEXP_WXLUADEBUG</a> <a class="code" href="classwxLuaDebugData.html">wxLuaDebugData</a>;
|
|
<a name="l00016"></a>00016
|
|
<a name="l00017"></a>00017 <span class="preprocessor">#ifdef WIN32</span>
|
|
<a name="l00018"></a>00018 <span class="preprocessor"></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> socklen_t;
|
|
<a name="l00019"></a>00019 <span class="preprocessor"> #include <winsock.h></span>
|
|
<a name="l00020"></a>00020 <span class="preprocessor">#else</span>
|
|
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor"> #include <unistd.h></span>
|
|
<a name="l00022"></a>00022 <span class="preprocessor"> #include <sys/types.h></span>
|
|
<a name="l00023"></a>00023 <span class="preprocessor"> #include <sys/socket.h></span>
|
|
<a name="l00024"></a>00024 <span class="preprocessor"> #include <netinet/in.h></span>
|
|
<a name="l00025"></a>00025 <span class="preprocessor"> #include <cerrno></span>
|
|
<a name="l00026"></a>00026 <span class="preprocessor"> #include <netdb.h></span>
|
|
<a name="l00027"></a>00027 <span class="preprocessor"> #include <arpa/inet.h></span>
|
|
<a name="l00028"></a><a class="code" href="wxlsock_8h.html#a26769957ec1a2beaf223f33b66ee64ab">00028</a> <span class="preprocessor"> #define INVALID_SOCKET -1</span>
|
|
<a name="l00029"></a><a class="code" href="wxlsock_8h.html#a633b0396ff93d336a088412a190a5072">00029</a> <span class="preprocessor"></span><span class="preprocessor"> #define SOCKET_ERROR -1</span>
|
|
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#endif // !WIN32</span>
|
|
<a name="l00031"></a>00031 <span class="preprocessor"></span>
|
|
<a name="l00032"></a>00032 <span class="comment">// This is the MSW version of SHUT_RDWR for ::shutdown(sock, how=SHUT_RDWR)</span>
|
|
<a name="l00033"></a>00033 <span class="comment">// Note that these are defined in winsock2.h, but if you try to include it</span>
|
|
<a name="l00034"></a>00034 <span class="comment">// you get errors about redefinitions since it includes winsock.h anyway</span>
|
|
<a name="l00035"></a>00035 <span class="preprocessor">#if !defined(SD_RECEIVE) && defined(SHUT_RD)</span>
|
|
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor"> #define SD_RECEIVE SHUT_RD</span>
|
|
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor"> #define SD_SEND SHUT_WR</span>
|
|
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor"> #define SD_BOTH SHUT_RDWR</span>
|
|
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#elif !defined(SD_RECEIVE)</span>
|
|
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor"> #define SD_RECEIVE 0</span>
|
|
<a name="l00041"></a><a class="code" href="wxlsock_8h.html#ab8d2ae8532f7f1a85345500eacfd3b84">00041</a> <span class="preprocessor"></span><span class="preprocessor"> #define SD_SEND 1</span>
|
|
<a name="l00042"></a><a class="code" href="wxlsock_8h.html#a06a11612afb43fedd0194d8b59cb02ed">00042</a> <span class="preprocessor"></span><span class="preprocessor"> #define SD_BOTH 2</span>
|
|
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#endif // SD_RECEIVE</span>
|
|
<a name="l00044"></a>00044 <span class="preprocessor"></span>
|
|
<a name="l00045"></a>00045
|
|
<a name="l00046"></a>00046 <span class="comment">// ----------------------------------------------------------------------------</span>
|
|
<a name="l00047"></a>00047 <span class="comment">// wxLuaSocketBase - a base class for different socket implementations</span>
|
|
<a name="l00048"></a>00048 <span class="comment">//</span>
|
|
<a name="l00049"></a>00049 <span class="comment">// The derived socket class must override</span>
|
|
<a name="l00050"></a>00050 <span class="comment">// virtual int Read(...) all ReadXXX functions use this</span>
|
|
<a name="l00051"></a>00051 <span class="comment">// virtual int Write(...) all WriteXXX functions use this</span>
|
|
<a name="l00052"></a>00052 <span class="comment">// virtual bool IsConnected()</span>
|
|
<a name="l00053"></a>00053 <span class="comment">// ----------------------------------------------------------------------------</span>
|
|
<a name="l00054"></a>00054
|
|
<a name="l00055"></a><a class="code" href="classwxLuaSocketBase.html">00055</a> <span class="keyword">class </span><a class="code" href="wxluasocketdefs_8h.html#a59aa1606e0b31648f147e5eb694362d8">WXDLLIMPEXP_WXLUASOCKET</a> <a class="code" href="classwxLuaSocketBase.html">wxLuaSocketBase</a> : <span class="keyword">public</span> wxObject
|
|
<a name="l00056"></a>00056 {
|
|
<a name="l00057"></a>00057 <span class="keyword">public</span>:
|
|
<a name="l00058"></a><a class="code" href="classwxLuaSocketBase.html#aff403d7f75c841046648192ba3464c68">00058</a> <a class="code" href="classwxLuaSocketBase.html#aff403d7f75c841046648192ba3464c68">wxLuaSocketBase</a>() : m_port_number(-1) {}
|
|
<a name="l00059"></a><a class="code" href="classwxLuaSocketBase.html#a9c6c849c6e4a2980373f91f37a1a2724">00059</a> <span class="keyword">virtual</span> <a class="code" href="classwxLuaSocketBase.html#a9c6c849c6e4a2980373f91f37a1a2724">~wxLuaSocketBase</a>() {}
|
|
<a name="l00060"></a>00060
|
|
<a name="l00061"></a>00061 <span class="comment">// Get the port used for the socket, -1 if not initialized</span>
|
|
<a name="l00062"></a><a class="code" href="classwxLuaSocketBase.html#a2a546b24ee009e29848f238a864261b1">00062</a> <span class="keywordtype">int</span> <a class="code" href="classwxLuaSocketBase.html#a2a546b24ee009e29848f238a864261b1">GetPortNumber</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_port_number; }
|
|
<a name="l00063"></a>00063 <span class="comment">// Get the address of the socket, empty string if not initialized</span>
|
|
<a name="l00064"></a><a class="code" href="classwxLuaSocketBase.html#a8082aa3a015fc8a09cd3abb108fee49c">00064</a> wxString <a class="code" href="classwxLuaSocketBase.html#a8082aa3a015fc8a09cd3abb108fee49c">GetAddress</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_address; }
|
|
<a name="l00065"></a>00065
|
|
<a name="l00066"></a>00066 <span class="comment">// Is the socket currently connected</span>
|
|
<a name="l00067"></a>00067 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsConnected() = 0;
|
|
<a name="l00068"></a>00068
|
|
<a name="l00069"></a>00069 <span class="comment">// Read the number of bytes length into buffer from the socket</span>
|
|
<a name="l00070"></a>00070 <span class="comment">// the buffer must be large enough to hold the data.</span>
|
|
<a name="l00071"></a>00071 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Read(<span class="keywordtype">char</span> *buffer, wxUint32 length) = 0;
|
|
<a name="l00072"></a>00072 <span class="comment">// Write the whole buffer of number of bytes length to the socket</span>
|
|
<a name="l00073"></a>00073 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Write(<span class="keyword">const</span> <span class="keywordtype">char</span> *buffer, wxUint32 length) = 0;
|
|
<a name="l00074"></a>00074
|
|
<a name="l00075"></a>00075 <span class="comment">// Note: Read/WriteCmd reads/writes a byte and if debugging prints the cmd/event type</span>
|
|
<a name="l00076"></a>00076
|
|
<a name="l00077"></a>00077 <span class="comment">// Read data from the socket, calls virtual int Read(...)</span>
|
|
<a name="l00078"></a>00078 <span class="comment">// false is returned on failure and the input var is not modified</span>
|
|
<a name="l00079"></a>00079 <span class="keywordtype">bool</span> ReadCmd(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>& value);
|
|
<a name="l00080"></a>00080 <span class="keywordtype">bool</span> ReadInt32(wxInt32& value);
|
|
<a name="l00081"></a>00081 <span class="keywordtype">bool</span> ReadLong(<span class="keywordtype">long</span>& value); <span class="comment">// reads platform independent long using a string</span>
|
|
<a name="l00082"></a>00082 <span class="keywordtype">bool</span> ReadString(wxString& value);
|
|
<a name="l00083"></a>00083 <span class="keywordtype">bool</span> ReadDebugData(<a class="code" href="classwxLuaDebugData.html">wxLuaDebugData</a>& data);
|
|
<a name="l00084"></a>00084
|
|
<a name="l00085"></a>00085 <span class="comment">// Write data to the socket, calls virtual void Write(...)</span>
|
|
<a name="l00086"></a>00086 <span class="comment">// returns success</span>
|
|
<a name="l00087"></a>00087 <span class="keywordtype">bool</span> WriteCmd(<span class="keywordtype">char</span> value);
|
|
<a name="l00088"></a>00088 <span class="keywordtype">bool</span> WriteInt32(wxInt32 value);
|
|
<a name="l00089"></a>00089 <span class="keywordtype">bool</span> WriteLong(<span class="keywordtype">long</span> value); <span class="comment">// write platform independent long using a string</span>
|
|
<a name="l00090"></a>00090 <span class="keywordtype">bool</span> WriteString(<span class="keyword">const</span> wxString &value);
|
|
<a name="l00091"></a>00091 <span class="keywordtype">bool</span> WriteDebugData(<span class="keyword">const</span> <a class="code" href="classwxLuaDebugData.html">wxLuaDebugData</a>& debugData);
|
|
<a name="l00092"></a>00092
|
|
<a name="l00093"></a>00093 <span class="comment">// Concat the error message array together and optionally clear the message</span>
|
|
<a name="l00094"></a>00094 <span class="keyword">virtual</span> wxString GetErrorMsg(<span class="keywordtype">bool</span> clear_msg);
|
|
<a name="l00095"></a>00095 <span class="comment">// Add a message to the internal error message and then append any</span>
|
|
<a name="l00096"></a>00096 <span class="comment">// additional from GetLastErrorMsg() to it.</span>
|
|
<a name="l00097"></a>00097 <span class="keywordtype">void</span> AddErrorMessage(<span class="keyword">const</span> wxString& msg);
|
|
<a name="l00098"></a>00098 <span class="comment">// Get the last/current error message as a string</span>
|
|
<a name="l00099"></a>00099 <span class="keyword">virtual</span> wxString GetLastErrorMsg() <span class="keyword">const</span> = 0;
|
|
<a name="l00100"></a>00100
|
|
<a name="l00101"></a>00101 <span class="comment">// implementation</span>
|
|
<a name="l00102"></a>00102
|
|
<a name="l00103"></a><a class="code" href="classwxLuaSocketBase.html#af593cd34e4a5e9d4c75aec92cd671694">00103</a> wxString m_name; <span class="comment">// human readable name of socket, for debugging</span>
|
|
<a name="l00104"></a><a class="code" href="classwxLuaSocketBase.html#a746947406eb385cc1a6f4c5926e34d58">00104</a> wxString m_errorMsg; <span class="comment">// human readable error message</span>
|
|
<a name="l00105"></a><a class="code" href="classwxLuaSocketBase.html#a1a25fff62281d6dcada8e88caf980003">00105</a> wxString m_address; <span class="comment">// The address for the socket to use</span>
|
|
<a name="l00106"></a><a class="code" href="classwxLuaSocketBase.html#a846769eac7d5cc6e30285ee7c0b20ccc">00106</a> <span class="keywordtype">int</span> m_port_number; <span class="comment">// The port that's used, else -1</span>
|
|
<a name="l00107"></a>00107
|
|
<a name="l00108"></a>00108 <span class="keyword">private</span>:
|
|
<a name="l00109"></a>00109 DECLARE_ABSTRACT_CLASS(<a class="code" href="classwxLuaSocketBase.html">wxLuaSocketBase</a>);
|
|
<a name="l00110"></a>00110 };
|
|
<a name="l00111"></a>00111
|
|
<a name="l00112"></a>00112 <span class="comment">// ----------------------------------------------------------------------------</span>
|
|
<a name="l00113"></a>00113 <span class="comment">// wxLuaCSocket - a C socket implementation for both client and server</span>
|
|
<a name="l00114"></a>00114 <span class="comment">// ----------------------------------------------------------------------------</span>
|
|
<a name="l00115"></a>00115
|
|
<a name="l00116"></a>00116 <span class="preprocessor">#ifdef WIN32</span>
|
|
<a name="l00117"></a>00117 <span class="preprocessor"></span> <span class="keyword">typedef</span> SOCKET <a class="code" href="wxlsock_8h.html#ad02a431b803b224450f8fcb371b5127d">socket_type</a>;
|
|
<a name="l00118"></a>00118 <span class="preprocessor">#else</span>
|
|
<a name="l00119"></a><a class="code" href="wxlsock_8h.html#ad02a431b803b224450f8fcb371b5127d">00119</a> <span class="preprocessor"></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="wxlsock_8h.html#ad02a431b803b224450f8fcb371b5127d">socket_type</a>;
|
|
<a name="l00120"></a>00120 <span class="preprocessor">#endif</span>
|
|
<a name="l00121"></a>00121 <span class="preprocessor"></span>
|
|
<a name="l00122"></a><a class="code" href="classwxLuaCSocket.html">00122</a> <span class="keyword">class </span><a class="code" href="wxluasocketdefs_8h.html#a59aa1606e0b31648f147e5eb694362d8">WXDLLIMPEXP_WXLUASOCKET</a> <a class="code" href="classwxLuaCSocket.html">wxLuaCSocket</a> : <span class="keyword">public</span> <a class="code" href="classwxLuaSocketBase.html">wxLuaSocketBase</a>
|
|
<a name="l00123"></a>00123 {
|
|
<a name="l00124"></a>00124 <span class="keyword">public</span>:
|
|
<a name="l00125"></a>00125
|
|
<a name="l00126"></a><a class="code" href="classwxLuaCSocket.html#ac00f4b305dbb658a820a3e0f710ee207">00126</a> <span class="keyword">enum</span> <a class="code" href="classwxLuaCSocket.html#ac00f4b305dbb658a820a3e0f710ee207">SocketState</a>
|
|
<a name="l00127"></a>00127 {
|
|
<a name="l00128"></a><a class="code" href="classwxLuaCSocket.html#ac00f4b305dbb658a820a3e0f710ee207ac62a2c3d8123af5043681f9b8738d079">00128</a> SOCKET_CLOSED,
|
|
<a name="l00129"></a><a class="code" href="classwxLuaCSocket.html#ac00f4b305dbb658a820a3e0f710ee207a31bab2a9a95a07b85d6edfd9df93c4f4">00129</a> SOCKET_LISTENING,
|
|
<a name="l00130"></a><a class="code" href="classwxLuaCSocket.html#ac00f4b305dbb658a820a3e0f710ee207aeb9e8e499495a51995b7275f6290bad9">00130</a> SOCKET_ACCEPTED,
|
|
<a name="l00131"></a><a class="code" href="classwxLuaCSocket.html#ac00f4b305dbb658a820a3e0f710ee207a4a13cfbefba47dc782f6560a7602ad24">00131</a> SOCKET_CONNECTED
|
|
<a name="l00132"></a>00132 };
|
|
<a name="l00133"></a>00133
|
|
<a name="l00134"></a>00134 <a class="code" href="classwxLuaCSocket.html">wxLuaCSocket</a>();
|
|
<a name="l00135"></a>00135 <span class="comment">// Socket constructor from an accepted socket</span>
|
|
<a name="l00136"></a>00136 <a class="code" href="classwxLuaCSocket.html">wxLuaCSocket</a>(<a class="code" href="wxlsock_8h.html#ad02a431b803b224450f8fcb371b5127d">socket_type</a> socket, sockaddr_in address);
|
|
<a name="l00137"></a>00137
|
|
<a name="l00138"></a>00138 <span class="keyword">virtual</span> ~<a class="code" href="classwxLuaCSocket.html">wxLuaCSocket</a>();
|
|
<a name="l00139"></a>00139
|
|
<a name="l00140"></a>00140 <span class="comment">// Create a listening socket, using the specified port number</span>
|
|
<a name="l00141"></a>00141 <span class="comment">// server: bind and listen for client connections</span>
|
|
<a name="l00142"></a>00142 <span class="keywordtype">bool</span> Listen(u_short port, <span class="keywordtype">int</span> backLog = 100);
|
|
<a name="l00143"></a>00143 <span class="comment">// Accept a connection, returning an accepted socket.</span>
|
|
<a name="l00144"></a>00144 <span class="comment">// server: block until accepting a connection from a client</span>
|
|
<a name="l00145"></a>00145 <a class="code" href="classwxLuaCSocket.html">wxLuaCSocket</a>* Accept();
|
|
<a name="l00146"></a>00146 <span class="comment">// Connect to a given host and port number</span>
|
|
<a name="l00147"></a>00147 <span class="comment">// client: connect a client to a server</span>
|
|
<a name="l00148"></a>00148 <span class="keywordtype">bool</span> Connect(<span class="keyword">const</span> wxString &address, u_short port);
|
|
<a name="l00149"></a>00149 <span class="comment">// Get the socket state</span>
|
|
<a name="l00150"></a><a class="code" href="classwxLuaCSocket.html#a1959a019b62873ba8200fedb177bf320">00150</a> <a class="code" href="classwxLuaCSocket.html#ac00f4b305dbb658a820a3e0f710ee207">SocketState</a> <a class="code" href="classwxLuaCSocket.html#a1959a019b62873ba8200fedb177bf320">GetState</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_sockstate; }
|
|
<a name="l00151"></a>00151 <span class="comment">// Get the socket handle</span>
|
|
<a name="l00152"></a><a class="code" href="classwxLuaCSocket.html#a6ad7363911a275fb6cf99a68dc6203a8">00152</a> <span class="keywordtype">int</span> <a class="code" href="classwxLuaCSocket.html#a6ad7363911a275fb6cf99a68dc6203a8">GetSocket</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_sock; }
|
|
<a name="l00153"></a>00153
|
|
<a name="l00154"></a>00154 <span class="comment">// Get the address of the opened socket</span>
|
|
<a name="l00155"></a>00155 wxString <a class="code" href="classwxLuaSocketBase.html#a8082aa3a015fc8a09cd3abb108fee49c">GetAddress</a>();
|
|
<a name="l00156"></a>00156 <span class="comment">// Get the port number of the opened socket</span>
|
|
<a name="l00157"></a>00157 <span class="keywordtype">int</span> GetPort();
|
|
<a name="l00158"></a>00158 <span class="comment">// Shutdown the socket in an orderly fashion, ::shutdown(sock, how)</span>
|
|
<a name="l00159"></a>00159 <span class="comment">// returns true on success</span>
|
|
<a name="l00160"></a>00160 <span class="keywordtype">bool</span> Shutdown(<span class="keywordtype">int</span> how = <a class="code" href="wxlsock_8h.html#a06a11612afb43fedd0194d8b59cb02ed">SD_BOTH</a>);
|
|
<a name="l00161"></a>00161 <span class="comment">// Close the open socket, returns true on success</span>
|
|
<a name="l00162"></a>00162 <span class="keywordtype">bool</span> Close();
|
|
<a name="l00163"></a>00163
|
|
<a name="l00164"></a>00164 <span class="comment">// Is the socket connected?</span>
|
|
<a name="l00165"></a>00165 <span class="comment">// Overridden from wxLuaSocketBase</span>
|
|
<a name="l00166"></a><a class="code" href="classwxLuaCSocket.html#a3e043bbae2269eac053efe418c15cdf9">00166</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classwxLuaSocketBase.html#a67256982445b40ef85411ff4ebc4e7a4">IsConnected</a>()
|
|
<a name="l00167"></a>00167 {
|
|
<a name="l00168"></a>00168 <span class="keywordflow">return</span> ((m_sockstate == SOCKET_CONNECTED) ||
|
|
<a name="l00169"></a>00169 (m_sockstate == SOCKET_ACCEPTED));
|
|
<a name="l00170"></a>00170 }
|
|
<a name="l00171"></a>00171
|
|
<a name="l00172"></a>00172 <span class="comment">// Read the whole buffer of byte size length into buffer from the socket</span>
|
|
<a name="l00173"></a>00173 <span class="comment">// Overridden from wxLuaSocketBase</span>
|
|
<a name="l00174"></a>00174 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classwxLuaSocketBase.html#ae448d9367271d0408d536d3767df1e15">Read</a>(<span class="keywordtype">char</span> *buffer, wxUint32 length);
|
|
<a name="l00175"></a>00175 <span class="comment">// Write the whole buffer of byte size length to the socket</span>
|
|
<a name="l00176"></a>00176 <span class="comment">// Overridden from wxLuaSocketBase</span>
|
|
<a name="l00177"></a>00177 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classwxLuaSocketBase.html#aa8a00aff8405aaca8540619fcad2e063">Write</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *buffer, wxUint32 length);
|
|
<a name="l00178"></a>00178
|
|
<a name="l00179"></a>00179 <span class="comment">// Get the last/current error message using the system error</span>
|
|
<a name="l00180"></a>00180 <span class="comment">// either errno in Unix or WSAGetLastError in MSW, doesn't clear error</span>
|
|
<a name="l00181"></a>00181 <span class="keyword">virtual</span> wxString <a class="code" href="classwxLuaSocketBase.html#a89399a52b300836dba42cee3fd0b4dfb">GetLastErrorMsg</a>() <span class="keyword">const</span>;
|
|
<a name="l00182"></a>00182
|
|
<a name="l00183"></a>00183 <span class="keyword">protected</span>:
|
|
<a name="l00184"></a>00184 <span class="comment">// Prevent copying and assignment of this class</span>
|
|
<a name="l00185"></a>00185 <a class="code" href="classwxLuaCSocket.html">wxLuaCSocket</a>(<span class="keyword">const</span> <a class="code" href="classwxLuaCSocket.html">wxLuaCSocket</a>&);
|
|
<a name="l00186"></a>00186 <a class="code" href="classwxLuaCSocket.html">wxLuaCSocket</a>& operator=(<span class="keyword">const</span> <a class="code" href="classwxLuaCSocket.html">wxLuaCSocket</a>&);
|
|
<a name="l00187"></a>00187
|
|
<a name="l00188"></a><a class="code" href="classwxLuaCSocket.html#ab512d84830f9826b49c47b5db38ca23d">00188</a> <a class="code" href="wxlsock_8h.html#ad02a431b803b224450f8fcb371b5127d">socket_type</a> m_sock;
|
|
<a name="l00189"></a><a class="code" href="classwxLuaCSocket.html#a25f3305d375a0df4caaed5df1e716901">00189</a> sockaddr_in m_sockaddress;
|
|
<a name="l00190"></a><a class="code" href="classwxLuaCSocket.html#adc2f96ba7c38196bd3237d63b814524d">00190</a> <a class="code" href="classwxLuaCSocket.html#ac00f4b305dbb658a820a3e0f710ee207">SocketState</a> m_sockstate;
|
|
<a name="l00191"></a>00191
|
|
<a name="l00192"></a>00192 <span class="keyword">private</span>:
|
|
<a name="l00193"></a>00193 <a class="code" href="classwxLuaSocketBase.html#a80e477af0c1eebb5dee13ce6662c4752">DECLARE_ABSTRACT_CLASS</a>(<a class="code" href="classwxLuaCSocket.html">wxLuaCSocket</a>);
|
|
<a name="l00194"></a>00194 };
|
|
<a name="l00195"></a>00195
|
|
<a name="l00196"></a>00196 <span class="comment">// ----------------------------------------------------------------------------</span>
|
|
<a name="l00197"></a>00197 <span class="comment">// wxLuawxSocket - Handles Debugger/Debuggee IO</span>
|
|
<a name="l00198"></a>00198 <span class="comment">// ----------------------------------------------------------------------------</span>
|
|
<a name="l00199"></a>00199 <span class="preprocessor">#include "wx/socket.h"</span>
|
|
<a name="l00200"></a>00200
|
|
<a name="l00201"></a><a class="code" href="classwxLuawxSocket.html">00201</a> <span class="keyword">class </span><a class="code" href="wxluasocketdefs_8h.html#a59aa1606e0b31648f147e5eb694362d8">WXDLLIMPEXP_WXLUASOCKET</a> <a class="code" href="classwxLuawxSocket.html">wxLuawxSocket</a> : <span class="keyword">public</span> <a class="code" href="classwxLuaSocketBase.html">wxLuaSocketBase</a>
|
|
<a name="l00202"></a>00202 {
|
|
<a name="l00203"></a>00203 <span class="keyword">public</span>:
|
|
<a name="l00204"></a><a class="code" href="classwxLuawxSocket.html#a21327958feeaddc610efc527d1ea7b65">00204</a> <a class="code" href="classwxLuawxSocket.html#a21327958feeaddc610efc527d1ea7b65">wxLuawxSocket</a>() : m_socket(NULL) {}
|
|
<a name="l00205"></a><a class="code" href="classwxLuawxSocket.html#a430c5db8807a5201099d809cb68ca532">00205</a> <a class="code" href="classwxLuawxSocket.html#a430c5db8807a5201099d809cb68ca532">wxLuawxSocket</a>(wxSocketBase* sock) : m_socket(sock) {}
|
|
<a name="l00206"></a>00206
|
|
<a name="l00207"></a><a class="code" href="classwxLuawxSocket.html#a16a6ee4c74c240a20270128c1fe90537">00207</a> <span class="keyword">virtual</span> <a class="code" href="classwxLuawxSocket.html#a16a6ee4c74c240a20270128c1fe90537">~wxLuawxSocket</a>() { Destroy(); }
|
|
<a name="l00208"></a>00208
|
|
<a name="l00209"></a>00209 <span class="comment">// Safely close and destroy the socket</span>
|
|
<a name="l00210"></a>00210 <span class="keywordtype">bool</span> Destroy();
|
|
<a name="l00211"></a>00211
|
|
<a name="l00212"></a>00212 <span class="comment">// Get/Set the socket, if you set a new socket you must delete the</span>
|
|
<a name="l00213"></a>00213 <span class="comment">// previous one first</span>
|
|
<a name="l00214"></a><a class="code" href="classwxLuawxSocket.html#ad999bad2e9e21bed07500c8b7714e1bf">00214</a> wxSocketBase* <a class="code" href="classwxLuawxSocket.html#ad999bad2e9e21bed07500c8b7714e1bf">GetSocket</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_socket; }
|
|
<a name="l00215"></a><a class="code" href="classwxLuawxSocket.html#a664dc50057860a6913c54cb70951de67">00215</a> <span class="keywordtype">void</span> <a class="code" href="classwxLuawxSocket.html#a664dc50057860a6913c54cb70951de67">SetSocket</a>(wxSocketBase* sock) { m_socket = sock; }
|
|
<a name="l00216"></a>00216 <span class="comment">// Socket Error from wxSocketBase</span>
|
|
<a name="l00217"></a><a class="code" href="classwxLuawxSocket.html#a31919768a1b60164e39fbc47dd62fcd8">00217</a> <span class="keywordtype">bool</span> <a class="code" href="classwxLuawxSocket.html#a31919768a1b60164e39fbc47dd62fcd8">Error</a>() { <span class="keywordflow">return</span> !m_socket || m_socket->Error(); }
|
|
<a name="l00218"></a>00218 <span class="comment">// Is Socket Connected, from wxSocketBase</span>
|
|
<a name="l00219"></a><a class="code" href="classwxLuawxSocket.html#ad8923b064bf4bc125f4cc636d0f2d7d7">00219</a> <span class="keywordtype">bool</span> <a class="code" href="classwxLuawxSocket.html#ad8923b064bf4bc125f4cc636d0f2d7d7">WaitForRead</a>(<span class="keywordtype">long</span> seconds = 0, <span class="keywordtype">long</span> milliseconds = 300) { <span class="keywordflow">return</span> m_socket && m_socket->WaitForRead(seconds, milliseconds); }
|
|
<a name="l00220"></a>00220
|
|
<a name="l00221"></a>00221 <span class="comment">// Is Socket Connected, from wxSocketBase</span>
|
|
<a name="l00222"></a><a class="code" href="classwxLuawxSocket.html#a2a638592f5e95aca811223302801b7ba">00222</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classwxLuawxSocket.html#a2a638592f5e95aca811223302801b7ba">IsConnected</a>() { <span class="keywordflow">return</span> m_socket && m_socket->IsConnected(); }
|
|
<a name="l00223"></a>00223
|
|
<a name="l00224"></a>00224 <span class="comment">// Read the whole buffer of size length into buffer buffer from the socket</span>
|
|
<a name="l00225"></a>00225 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classwxLuaSocketBase.html#ae448d9367271d0408d536d3767df1e15">Read</a>(<span class="keywordtype">char</span> *buffer, wxUint32 length);
|
|
<a name="l00226"></a>00226 <span class="comment">// Write the whole buffer of size length to the socket</span>
|
|
<a name="l00227"></a>00227 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classwxLuaSocketBase.html#aa8a00aff8405aaca8540619fcad2e063">Write</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *buffer, wxUint32 length);
|
|
<a name="l00228"></a>00228
|
|
<a name="l00229"></a>00229 <span class="keyword">virtual</span> wxString <a class="code" href="classwxLuaSocketBase.html#a89399a52b300836dba42cee3fd0b4dfb">GetLastErrorMsg</a>() <span class="keyword">const</span>;
|
|
<a name="l00230"></a>00230
|
|
<a name="l00231"></a>00231 <span class="keyword">protected</span>:
|
|
<a name="l00232"></a><a class="code" href="classwxLuawxSocket.html#aa0d8d61057d03e1340615e55949c1432">00232</a> wxSocketBase* m_socket;
|
|
<a name="l00233"></a>00233 };
|
|
<a name="l00234"></a>00234
|
|
<a name="l00235"></a>00235 <span class="comment">// ----------------------------------------------------------------------------</span>
|
|
<a name="l00236"></a>00236 <span class="comment">// wxLuaSocket - Choose the socket we want to use</span>
|
|
<a name="l00237"></a>00237 <span class="comment">// ----------------------------------------------------------------------------</span>
|
|
<a name="l00238"></a>00238
|
|
<a name="l00239"></a><a class="code" href="wxlsock_8h.html#a4a01c351beb404ceb5c232d26cb44e15">00239</a> <span class="keyword">typedef</span> <a class="code" href="classwxLuaCSocket.html">wxLuaCSocket</a> <a class="code" href="classwxLuaCSocket.html">wxLuaSocket</a>;
|
|
<a name="l00240"></a>00240
|
|
<a name="l00241"></a>00241 <span class="preprocessor">#endif // WX_LUA_SOCKET_H_</span>
|
|
</pre></div></div>
|
|
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 13 10:30:39 2010 for wxLua by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
|
|
</body>
|
|
</html>
|