Corrected issues with documentation

This commit is contained in:
Zachariah Brown committed 2016-01-19 12:38:39 -05:00
1 parent e8224208a2
commit 66451e6596
13 files changed
+57 -58

No files matched your search

+7 -7
View File
@@ -189,11 +189,11 @@ sfFtpResponse* sfFtp_loginAnonymous(sfFtp* ftp)
////////////////////////////////////////////////////////////
sfFtpResponse* sfFtp_login(sfFtp* ftp, const char* userName, const char* password)
sfFtpResponse* sfFtp_login(sfFtp* ftp, const char* name, const char* password)
{
CSFML_CHECK_RETURN(ftp, NULL);
return new sfFtpResponse(ftp->This.login(userName ? userName : "", password ? password : ""));
return new sfFtpResponse(ftp->This.login(name ? name : "", password ? password : ""));
}
@@ -288,23 +288,23 @@ sfFtpResponse* sfFtp_deleteFile(sfFtp* ftp, const char* name)
////////////////////////////////////////////////////////////
sfFtpResponse* sfFtp_download(sfFtp* ftp, const char* distantFile, const char* destPath, sfFtpTransferMode mode)
sfFtpResponse* sfFtp_download(sfFtp* ftp, const char* remoteFile, const char* localPath, sfFtpTransferMode mode)
{
CSFML_CHECK_RETURN(ftp, NULL);
return new sfFtpResponse(ftp->This.download(distantFile ? distantFile : "",
destPath ? destPath : "",
return new sfFtpResponse(ftp->This.download(remoteFile ? remoteFile : "",
localPath ? localPath : "",
static_cast<sf::Ftp::TransferMode>(mode)));
}
////////////////////////////////////////////////////////////
sfFtpResponse* sfFtp_upload(sfFtp* ftp, const char* localFile, const char* destPath, sfFtpTransferMode mode)
sfFtpResponse* sfFtp_upload(sfFtp* ftp, const char* localFile, const char* remotePath, sfFtpTransferMode mode)
{
CSFML_CHECK_RETURN(ftp, NULL);
return new sfFtpResponse(ftp->This.upload(localFile ? localFile : "",
destPath ? destPath : "",
remotePath ? remotePath : "",
static_cast<sf::Ftp::TransferMode>(mode)));
}
+8 -8
View File
@@ -89,13 +89,13 @@ unsigned short sfTcpSocket_getRemotePort(const sfTcpSocket* socket)
////////////////////////////////////////////////////////////
sfSocketStatus sfTcpSocket_connect(sfTcpSocket* socket, sfIpAddress host, unsigned short port, sfTime timeout)
sfSocketStatus sfTcpSocket_connect(sfTcpSocket* socket, sfIpAddress remoteAddress, unsigned short remotePort, sfTime timeout)
{
sf::IpAddress address(host.address);
sf::IpAddress address(remoteAddress.address);
CSFML_CHECK_RETURN(socket, sfSocketError);
return static_cast<sfSocketStatus>(socket->This.connect(address, port, sf::microseconds(timeout.microseconds)));
return static_cast<sfSocketStatus>(socket->This.connect(address, remotePort, sf::microseconds(timeout.microseconds)));
}
@@ -125,18 +125,18 @@ sfSocketStatus sfTcpSocket_sendPartial(sfTcpSocket* socket, const void* data, si
////////////////////////////////////////////////////////////
sfSocketStatus sfTcpSocket_receive(sfTcpSocket* socket, void* data, size_t maxSize, size_t* sizeReceived)
sfSocketStatus sfTcpSocket_receive(sfTcpSocket* socket, void* data, size_t size, size_t* received)
{
CSFML_CHECK_RETURN(socket, sfSocketError);
if (sizeReceived)
if (received)
{
return static_cast<sfSocketStatus>(socket->This.receive(data, maxSize, *sizeReceived));
return static_cast<sfSocketStatus>(socket->This.receive(data, size, *received));
}
else
{
std::size_t size = 0;
return static_cast<sfSocketStatus>(socket->This.receive(data, maxSize, size));
std::size_t tempReceived = 0;
return static_cast<sfSocketStatus>(socket->This.receive(data, size, tempReceived));
}
}
+26 -26
View File
@@ -84,74 +84,74 @@ void sfUdpSocket_unbind(sfUdpSocket* socket)
////////////////////////////////////////////////////////////
sfSocketStatus sfUdpSocket_send(sfUdpSocket* socket, const void* data, size_t size, sfIpAddress address, unsigned short port)
sfSocketStatus sfUdpSocket_send(sfUdpSocket* socket, const void* data, size_t size, sfIpAddress remoteAddress, unsigned short remotePort)
{
CSFML_CHECK_RETURN(socket, sfSocketError);
// Convert the address
sf::IpAddress receiver(address.address);
sf::IpAddress address(remoteAddress.address);
return static_cast<sfSocketStatus>(socket->This.send(data, size, receiver, port));
return static_cast<sfSocketStatus>(socket->This.send(data, size, address, remotePort));
}
////////////////////////////////////////////////////////////
sfSocketStatus sfUdpSocket_receive(sfUdpSocket* socket, void* data, size_t maxSize, size_t* sizeReceived, sfIpAddress* address, unsigned short* port)
sfSocketStatus sfUdpSocket_receive(sfUdpSocket* socket, void* data, size_t size, size_t* received, sfIpAddress* remoteAddress, unsigned short* remotePort)
{
CSFML_CHECK_RETURN(socket, sfSocketError);
// Call SFML internal function
sf::IpAddress sender;
unsigned short senderPort;
std::size_t received;
sf::IpAddress address;
unsigned short port;
std::size_t sizeReceived;
sf::Socket::Status status = socket->This.receive(data, maxSize, received, sender, senderPort);
sf::Socket::Status status = socket->This.receive(data, size, sizeReceived, address, port);
if (status != sf::Socket::Done)
return static_cast<sfSocketStatus>(status);
if (sizeReceived)
*sizeReceived = received;
if (received)
*received = sizeReceived;
if (address)
strncpy(address->address, sender.toString().c_str(), 16);
if (remoteAddress)
strncpy(remoteAddress->address, address.toString().c_str(), 16);
if (port)
*port = senderPort;
if (remotePort)
*remotePort = port;
return sfSocketDone;
}
////////////////////////////////////////////////////////////
sfSocketStatus sfUdpSocket_sendPacket(sfUdpSocket* socket, sfPacket* packet, sfIpAddress address, unsigned short port)
sfSocketStatus sfUdpSocket_sendPacket(sfUdpSocket* socket, sfPacket* packet, sfIpAddress remoteAddress, unsigned short remotePort)
{
CSFML_CHECK_RETURN(socket, sfSocketError);
CSFML_CHECK_RETURN(packet, sfSocketError);
// Convert the address
sf::IpAddress receiver(address.address);
sf::IpAddress address(remoteAddress.address);
return static_cast<sfSocketStatus>(socket->This.send(packet->This, receiver, port));
return static_cast<sfSocketStatus>(socket->This.send(packet->This, address, remotePort));
}
////////////////////////////////////////////////////////////
sfSocketStatus sfUdpSocket_receivePacket(sfUdpSocket* socket, sfPacket* packet, sfIpAddress* address, unsigned short* port)
sfSocketStatus sfUdpSocket_receivePacket(sfUdpSocket* socket, sfPacket* packet, sfIpAddress* remoteAddress, unsigned short* remotePort)
{
CSFML_CHECK_RETURN(socket, sfSocketError);
CSFML_CHECK_RETURN(packet, sfSocketError);
sf::IpAddress sender;
unsigned short senderPort;
sf::Socket::Status status = socket->This.receive(packet->This, sender, senderPort);
sf::IpAddress address;
unsigned short port;
sf::Socket::Status status = socket->This.receive(packet->This, address, port);
if (status != sf::Socket::Done)
return static_cast<sfSocketStatus>(status);
if (address)
strncpy(address->address, sender.toString().c_str(), 16);
if (remoteAddress)
strncpy(remoteAddress->address, address.toString().c_str(), 16);
if (port)
*port = senderPort;
if (remotePort)
*remotePort = port;
return sfSocketDone;
}