Documentation for module: Network

Former-commit-id: 0563349542b717b602d5a6eb7728bd40b2af7e1f

include/Nazara/Network/RUdpConnection.inl

@@ -8,31 +8,66 @@
 
 namespace Nz
 {
+	/*!
+	* \brief Closes the connection
+	*/
+
 	inline void RUdpConnection::Close()
 	{
 		m_socket.Close();
 	}
 
+	/*!
+	* \brief Disconnects the connection
+	*
+	* \see Close
+	*/
+
 	inline void RUdpConnection::Disconnect()
 	{
 		Close();
 	}
 
+	/*!
+	* \brief Gets the bound address
+	* \return IpAddress we are linked to
+	*/
+
 	inline IpAddress RUdpConnection::GetBoundAddress() const
 	{
 		return m_socket.GetBoundAddress();
 	}
 
+	/*!
+	* \brief Gets the port of the bound address
+	* \return Port we are linked to
+	*/
+
 	inline UInt16 RUdpConnection::GetBoundPort() const
 	{
 		return m_socket.GetBoundPort();
 	}
 
+	/*!
+	* \brief Gets the last error
+	* \return Socket error
+	*/
+
 	inline SocketError RUdpConnection::GetLastError() const
 	{
 		return m_lastError;
 	}
 
+	/*!
+	* \brief Listens to a socket
+	* \return true If successfully bound
+	*
+	* \param protocol Net protocol to listen to
+	* \param port Port to listen to
+	*
+	* \remark Produces a NazaraAssert if protocol is unknown or any
+	*/
+
 	inline bool RUdpConnection::Listen(NetProtocol protocol, UInt16 port)
 	{
 		NazaraAssert(protocol != NetProtocol_Any, "Any protocol not supported for Listen"); //< TODO
@@ -59,16 +94,36 @@ namespace Nz
 		return Listen(any);
 	}
 
+	/*!
+	* \brief Sets the protocol id
+	*
+	* \param protocolId Protocol ID like NNet
+	*/
+
 	inline void RUdpConnection::SetProtocolId(UInt32 protocolId)
 	{
 		m_protocol = protocolId;
 	}
 
+	/*!
+	* \brief Sets the time before ack
+	*
+	* \param Time before acking to send many together (in ms)
+	*/
+
 	inline void RUdpConnection::SetTimeBeforeAck(UInt32 ms)
 	{
 		m_forceAckSendTime = ms * 1000; //< Store in microseconds for easier handling
 	}
-	
+
+	/*!
+	* \brief Computes the difference of sequence
+	* \return Delta between the two sequences
+	*
+	* \param sequence First sequence
+	* \param sequence2 Second sequence
+	*/
+
 	inline unsigned int RUdpConnection::ComputeSequenceDifference(SequenceIndex sequence, SequenceIndex sequence2)
 	{
 		unsigned int difference;
@@ -80,6 +135,13 @@ namespace Nz
 		return 0;
 	}
 
+	/*!
+	* \brief Checks whether the peer has pending packets
+	* \return true If it is the case
+	*
+	* \param peer Data relative to the peer
+	*/
+
 	inline bool RUdpConnection::HasPendingPackets(PeerData& peer)
 	{
 		for (unsigned int priority = PacketPriority_Highest; priority <= PacketPriority_Lowest; ++priority)
@@ -94,6 +156,14 @@ namespace Nz
 		return false;
 	}
 
+	/*!
+	* \brief Checks whether the ack is more recent
+	* \return true If it is the case
+	*
+	* \param ack First sequence
+	* \param ack2 Second sequence
+	*/
+
 	inline bool RUdpConnection::IsAckMoreRecent(SequenceIndex ack, SequenceIndex ack2)
 	{
 		constexpr SequenceIndex maxDifference = std::numeric_limits<SequenceIndex>::max() / 2;
@@ -106,6 +176,13 @@ namespace Nz
 			return false; ///< Same ack
 	}
 
+	/*!
+	* \brief Checks whether the connection is reliable
+	* \return true If it is the case
+	*
+	* \remark Produces a NazaraError if enumeration is invalid
+	*/
+
 	inline bool RUdpConnection::IsReliable(PacketReliability reliability)
 	{
 		switch (reliability)
@@ -122,6 +199,14 @@ namespace Nz
 		return false;
 	}
 
+	/*!
+	* \brief Simulates the loss of packets on network
+	*
+	* \param packetLoss Ratio of packet loss according to bernoulli distribution
+	*
+	* \remark Produces a NazaraAssert if packetLoss is not in between 0.0 and 1.0
+	*/
+
 	inline void RUdpConnection::SimulateNetwork(double packetLoss)
 	{
 		NazaraAssert(packetLoss >= 0.0 && packetLoss <= 1.0, "Packet loss must be in range [0..1]");