diff --git a/Source/Engine/Platform/Base/NetworkBase.h b/Source/Engine/Platform/Base/NetworkBase.h index 4b9c10196..805ca246e 100644 --- a/Source/Engine/Platform/Base/NetworkBase.h +++ b/Source/Engine/Platform/Base/NetworkBase.h @@ -91,14 +91,14 @@ class FLAXENGINE_API NetworkBase /// The socket struct to fill in. /// The protocol. /// The ip version. - /// Return true on error. Otherwise false. + /// Returns true on error, otherwise false. static bool CreateSocket(NetworkSocket& socket, NetworkProtocolType proto, NetworkIPVersion ipv); /// /// Closes native socket. /// /// The socket. - /// Return true on error. Otherwise false. + /// Returns true on error, otherwise false. static bool DestroySocket(NetworkSocket& socket); /// @@ -107,7 +107,7 @@ class FLAXENGINE_API NetworkBase /// The socket. /// The option. /// The value. - /// Return true on error. Otherwise false. + /// Returns true on error, otherwise false. static bool SetSocketOption(NetworkSocket& socket, NetworkSocketOption option, bool value); /// @@ -116,7 +116,7 @@ class FLAXENGINE_API NetworkBase /// The socket. /// The option. /// The value. - /// Return true on error. Otherwise false. + /// Returns true on error, otherwise false. static bool SetSocketOption(NetworkSocket& socket, NetworkSocketOption option, int32 value); /// @@ -125,7 +125,7 @@ class FLAXENGINE_API NetworkBase /// The socket. /// The option. /// The returned value. - /// Return true on error. Otherwise false. + /// Returns true on error, otherwise false. static bool GetSocketOption(NetworkSocket& socket, NetworkSocketOption option, bool* value); /// @@ -134,7 +134,7 @@ class FLAXENGINE_API NetworkBase /// The socket. /// The option. /// The returned value. - /// Return true on error. Otherwise false. + /// Returns true on error, otherwise false. static bool GetSocketOption(NetworkSocket& socket, NetworkSocketOption option, int32* value); /// @@ -142,7 +142,7 @@ class FLAXENGINE_API NetworkBase /// /// The socket. /// The end point. - /// Return true on error. Otherwise false. + /// Returns true on error, otherwise false. static bool ConnectSocket(NetworkSocket& socket, NetworkEndPoint& endPoint); /// @@ -150,7 +150,7 @@ class FLAXENGINE_API NetworkBase /// /// The socket. /// The end point. - /// Return true on error. Otherwise false. + /// Returns true on error, otherwise false. static bool BindSocket(NetworkSocket& socket, NetworkEndPoint& endPoint); /// @@ -158,7 +158,7 @@ class FLAXENGINE_API NetworkBase /// /// The socket. /// Pending connection queue size. - /// Return true on error. Otherwise false. + /// Returns true on error, otherwise false. static bool Listen(NetworkSocket& socket, uint16 queueSize); /// @@ -167,28 +167,28 @@ class FLAXENGINE_API NetworkBase /// The socket. /// The newly connected socket. /// The end point of the new socket. - /// Return true on error. Otherwise false. + /// Returns true on error, otherwise false. static bool Accept(NetworkSocket& serverSock, NetworkSocket& newSock, NetworkEndPoint& newEndPoint); /// /// Checks for socket readability. /// /// The socket. - /// Return true when data is available. Otherwise false. + /// Returns true when data is available. Otherwise false. static bool IsReadable(NetworkSocket& socket); /// /// Checks for socket writeability. /// /// The socket. - /// Return true when data can be written. Otherwise false. + /// Returns true when data can be written. Otherwise false. static bool IsWriteable(NetworkSocket& socket); /// /// Updates sockets states. /// /// The sockets group. - /// Return -1 on error, The number of elements where states are nonzero, otherwise 0. + /// Returns -1 on error, The number of elements where states are nonzero, otherwise 0. static int32 Poll(NetworkSocketGroup& group); /// @@ -197,7 +197,7 @@ class FLAXENGINE_API NetworkBase /// The group. /// The socket index in group. /// The returned state. - /// Return true on error. Otherwise false. + /// Returns true on error, otherwise false. static bool GetSocketState(NetworkSocketGroup& group, uint32 index, NetworkSocketState& state); /// @@ -205,7 +205,7 @@ class FLAXENGINE_API NetworkBase /// /// The group. /// The socket. - /// Return the socket index in group or -1 on error. + /// Returns the socket index in group or -1 on error. static int32 AddSocketToGroup(NetworkSocketGroup& group, NetworkSocket& socket); /// @@ -221,7 +221,7 @@ class FLAXENGINE_API NetworkBase /// The data to write. /// The length of data. /// If protocol is UDP , the destination end point. Otherwise nullptr. - /// Return -1 on error, otherwise bytes written. + /// Returns -1 on error, otherwise bytes written. static int32 WriteSocket(NetworkSocket socket, byte* data, uint32 length, NetworkEndPoint* endPoint = nullptr); /// @@ -231,7 +231,7 @@ class FLAXENGINE_API NetworkBase /// The buffer. /// Size of the buffer. /// If UDP, the end point from where data is coming. Otherwise nullptr. - /// Return -1 on error, otherwise bytes read. + /// Returns -1 on error, otherwise bytes read. static int32 ReadSocket(NetworkSocket socket, byte* buffer, uint32 bufferSize, NetworkEndPoint* endPoint = nullptr); /// @@ -242,7 +242,7 @@ class FLAXENGINE_API NetworkBase /// The ip version. /// The created end point. /// True if the end point will be connected or binded. - /// Return true on error. Otherwise false. + /// Returns true on error, otherwise false. static bool CreateEndPoint(String* address, String* port, NetworkIPVersion ipv, NetworkEndPoint& endPoint, bool bindable = false); ///