documentation.HELP! SFML v1.6 Documentation

SFML - Simple and Fast Multimedia Library

SFML v1.6

previous page next page

sf::Ftp::Ftp::Response Class Reference

This class wraps a FTP response, which is basically :

• a status code
• a message.

More...

#include <Ftp.hpp>

Inheritance diagram for sf::Ftp::Ftp::Response:

List of all members.

Public Types
enum	Status {   RestartMarkerReply = 110,   ServiceReadySoon = 120,   DataConnectionAlreadyOpened = 125,   OpeningDataConnection = 150,   Ok = 200,   PointlessCommand = 202,   SystemStatus = 211,   DirectoryStatus = 212,   FileStatus = 213,   HelpMessage = 214,   SystemType = 215,   ServiceReady = 220,   ClosingConnection = 221,   DataConnectionOpened = 225,   ClosingDataConnection = 226,   EnteringPassiveMode = 227,   LoggedIn = 230,   FileActionOk = 250,   DirectoryOk = 257,   NeedPassword = 331,   NeedAccountToLogIn = 332,   NeedInformation = 350,   ServiceUnavailable = 421,   DataConnectionUnavailable = 425,   TransferAborted = 426,   FileActionAborted = 450,   LocalError = 451,   InsufficientStorageSpace = 452,   CommandUnknown = 500,   ParametersUnknown = 501,   CommandNotImplemented = 502,   BadCommandSequence = 503,   ParameterNotImplemented = 504,   NotLoggedIn = 530,   NeedAccountToStore = 532,   FileUnavailable = 550,   PageTypeUnknown = 551,   NotEnoughMemory = 552,   FilenameNotAllowed = 553,   InvalidResponse = 1000,   ConnectionFailed = 1001,   ConnectionClosed = 1002,   InvalidFile = 1003 }
	Enumerate all the valid status codes returned in a FTP response. More...
Public Member Functions
	Response (Status Code=InvalidResponse, const std::string &Message="")
	Default constructor.
bool	IsOk () const
	Convenience function to check if the response status code means a success.
Status	GetStatus () const
	Get the response status code.
const std::string &	GetMessage () const
	Get the full message contained in the response.

---

Detailed Description

This class wraps a FTP response, which is basically :

• a status code
• a message.

Definition at line 66 of file Ftp.hpp.

---

Member Enumeration Documentation

enum sf::Ftp::Response::Status

Enumerate all the valid status codes returned in a FTP response.

Enumerator:

RestartMarkerReply	Restart marker reply.
ServiceReadySoon	Service ready in N minutes.
DataConnectionAlreadyOpened	Data connection already opened, transfer starting.
OpeningDataConnection	File status ok, about to open data connection.
Ok	Command ok.
PointlessCommand	Command not implemented.
SystemStatus	System status, or system help reply.
DirectoryStatus	Directory status.
FileStatus	File status.
HelpMessage	Help message.
SystemType	NAME system type, where NAME is an official system name from the list in the Assigned Numbers document.
ServiceReady	Service ready for new user.
ClosingConnection	Service closing control connection.
DataConnectionOpened	Data connection open, no transfer in progress.
ClosingDataConnection	Closing data connection, requested file action successful.
EnteringPassiveMode	Entering passive mode.
LoggedIn	User logged in, proceed. Logged out if appropriate.
FileActionOk	Requested file action ok.
DirectoryOk	PATHNAME created.
NeedPassword	User name ok, need password.
NeedAccountToLogIn	Need account for login.
NeedInformation	Requested file action pending further information.
ServiceUnavailable	Service not available, closing control connection.
DataConnectionUnavailable	Can't open data connection.
TransferAborted	Connection closed, transfer aborted.
FileActionAborted	Requested file action not taken.
LocalError	Requested action aborted, local error in processing.
InsufficientStorageSpace	Requested action not taken; insufficient storage space in system, file unavailable.
CommandUnknown	Syntax error, command unrecognized.
ParametersUnknown	Syntax error in parameters or arguments.
CommandNotImplemented	Command not implemented.
BadCommandSequence	Bad sequence of commands.
ParameterNotImplemented	Command not implemented for that parameter.
NotLoggedIn	Not logged in.
NeedAccountToStore	Need account for storing files.
FileUnavailable	Requested action not taken, file unavailable.
PageTypeUnknown	Requested action aborted, page type unknown.
NotEnoughMemory	Requested file action aborted, exceeded storage allocation.
FilenameNotAllowed	Requested action not taken, file name not allowed.
InvalidResponse	Response is not a valid FTP one.
ConnectionFailed	Connection with server failed.
ConnectionClosed	Connection with server closed.
InvalidFile	Invalid file to upload / download.

Definition at line 74 of file Ftp.hpp.

---

Constructor & Destructor Documentation

sf::Ftp::Ftp::Response::Response	(	Status	Code = InvalidResponse,
		const std::string &	Message = ""
	)

Default constructor.

Parameters:

	Code	: Response status code (InvalidResponse by default)
	Message	: Response message (empty by default)

Definition at line 84 of file Ftp.cpp.

---

Member Function Documentation

const std::string & sf::Ftp::Ftp::Response::GetMessage

(

)

const

Get the full message contained in the response.

Returns:

The response message

Definition at line 114 of file Ftp.cpp.

Ftp::Response::Status sf::Ftp::Ftp::Response::GetStatus

(

)

const

Get the response status code.

Returns:

Status code

Definition at line 105 of file Ftp.cpp.

bool sf::Ftp::Ftp::Response::IsOk

(

)

const

Convenience function to check if the response status code means a success.

Convenience function to check if the response status code means a success.

Returns:

True if status is success (code < 400)

Definition at line 96 of file Ftp.cpp.

---

The documentation for this class was generated from the following files:

• Ftp.hpp
• Ftp.cpp

 ::  Copyright © 2007-2008 Laurent Gomila, all rights reserved  ::  Documentation generated by doxygen 1.5.2  :: 

previous page start next page

Menu

• Homepage

Table of contents

• Main Page
• Class List
  • sf::AudioResource
  • sf::Clock
  • sf::Color
  • sf::Context
  • sf::Drawable
  • sf::Event
  • sf::Event::Event::JoyButtonEvent
  • sf::Event::Event::JoyMoveEvent
  • sf::Event::Event::KeyEvent
  • sf::Event::Event::MouseButtonEvent
  • sf::Event::Event::MouseMoveEvent
  • sf::Event::Event::MouseWheelEvent
  • sf::Event::Event::SizeEvent
  • sf::Event::Event::TextEvent
  • sf::Font
  • sf::Ftp
  • sf::Ftp::Ftp::DirectoryResponse
  • sf::Ftp::Ftp::ListingResponse
  • sf::Ftp::Ftp::Response
  • sf::Glyph
  • sf::Http
  • sf::Http::Http::Request
  • sf::Http::Http::Response
  • sf::Image
  • sf::Input
  • sf::IPAddress
  • sf::Listener
  • sf::Lock
  • sf::Matrix3
  • sf::Music
  • sf::Mutex
  • sf::NonCopyable
  • sf::Packet
  • sf::PostFX
  • sf::Randomizer
  • sf::Rect< T >
  • sf::RenderTarget
  • sf::RenderWindow
  • sf::Resource< T >
  • sf::ResourcePtr< T >
  • sf::Selector< Type >
  • sf::SelectorBase
  • sf::Shape
  • sf::SocketHelper
  • sf::SocketTCP
  • sf::SocketUDP
  • sf::Sound
  • sf::SoundBuffer
  • sf::SoundBufferRecorder
  • sf::SoundRecorder
  • sf::SoundStream
  • sf::SoundStream::SoundStream::Chunk
  • sf::Sprite
  • sf::String
  • sf::Thread
  • sf::Unicode
  • sf::Unicode::Unicode::Text
  • sf::Vector2< T >
  • sf::Vector3< T >
  • sf::VideoMode
  • sf::View
  • sf::Window
  • sf::WindowListener
  • sf::WindowSettings
• Class Hierarchy
  • sf::AudioResource
    • sf::Sound
      • sf::SoundStream
        • sf::Music
    • sf::SoundBuffer
  • sf::Clock
  • sf::Color
  • sf::Drawable
    • sf::PostFX
    • sf::Shape
    • sf::Sprite
    • sf::String
  • sf::Event
  • sf::Event::Event::JoyButtonEvent
  • sf::Event::Event::JoyMoveEvent
  • sf::Event::Event::KeyEvent
  • sf::Event::Event::MouseButtonEvent
  • sf::Event::Event::MouseMoveEvent
  • sf::Event::Event::MouseWheelEvent
  • sf::Event::Event::SizeEvent
  • sf::Event::Event::TextEvent
  • sf::Ftp::Ftp::Response
    • sf::Ftp::Ftp::DirectoryResponse
    • sf::Ftp::Ftp::ListingResponse
  • sf::Glyph
  • sf::Http::Http::Request
  • sf::Http::Http::Response
  • sf::IPAddress
  • sf::Listener
  • sf::Matrix3
  • sf::NonCopyable
    • sf::Context
    • sf::Ftp
    • sf::Http
    • sf::Input
    • sf::Lock
    • sf::Mutex
    • sf::Thread
      • sf::SoundRecorder
        • sf::SoundBufferRecorder
      • sf::SoundStream
    • sf::Window
      • sf::RenderWindow
  • sf::Packet
  • sf::Randomizer
  • sf::Rect< T >
  • sf::RenderTarget
    • sf::RenderWindow
  • sf::Resource< T >
  • sf::Resource< Font >
    • sf::Font
  • sf::Resource< Image >
    • sf::Image
  • sf::Resource< SoundBuffer >
    • sf::SoundBuffer
  • sf::ResourcePtr< T >
  • sf::SelectorBase
    • sf::Selector< Type >
  • sf::SocketHelper
  • sf::SocketTCP
  • sf::SocketUDP
  • sf::SoundStream::SoundStream::Chunk
  • sf::Unicode
  • sf::Unicode::Unicode::Text
  • sf::Vector2< T >
  • sf::Vector3< T >
  • sf::VideoMode
  • sf::View
  • sf::WindowListener
    • sf::Input
    • sf::Window
  • sf::WindowSettings
• Class Members
• Namespace List
  • sf::Blend
  • sf::Joy
  • sf::Key
  • sf::Mouse
  • sf::Style
• Namespace Members
• File List
  • Arial.hpp
  • Audio.hpp
  • AudioDevice.cpp
  • AudioDevice.hpp
  • AudioResource.cpp
  • AudioResource.hpp
  • Clock.cpp
  • Clock.hpp
  • Color.cpp
  • Color.hpp
  • Config.hpp
  • Context.cpp
  • Context.hpp
  • Doxygen.hpp
  • Drawable.cpp
  • Drawable.hpp
  • Event.hpp
  • Font.cpp
  • Font.hpp
  • FontLoader.cpp
  • FontLoader.hpp
  • Ftp.cpp
  • Ftp.hpp
  • Glyph.hpp
  • Graphics.hpp
  • GraphicsContext.cpp
  • GraphicsContext.hpp
  • Http.cpp
  • Http.hpp
  • Image.cpp
  • Image.hpp
  • ImageLoader.cpp
  • ImageLoader.hpp
  • Input.cpp
  • Input.hpp
  • IPAddress.cpp
  • IPAddress.hpp
  • Cocoa/Joystick.cpp
  • Template for new ports/Joystick.cpp
  • Win32/Joystick.cpp
  • Cocoa/Joystick.hpp
  • Joystick.hpp
  • Template for new ports/Joystick.hpp
  • Win32/Joystick.hpp
  • Listener.cpp
  • Listener.hpp
  • Lock.cpp
  • Lock.hpp
  • Matrix3.cpp
  • Matrix3.hpp
  • Matrix3.inl
  • Music.cpp
  • Music.hpp
  • Mutex.cpp
  • Mutex.hpp
  • Win32/Mutex.hpp
  • Network.hpp
  • NonCopyable.hpp
  • OpenAL.hpp
  • OpenGL.hpp
  • Packet.cpp
  • Packet.hpp
  • Platform.cpp
  • Platform.hpp
  • Win32/Platform.hpp
  • PostFX.cpp
  • PostFX.hpp
  • Randomizer.cpp
  • Randomizer.hpp
  • Rect.hpp
  • Rect.inl
  • RenderTarget.cpp
  • RenderTarget.hpp
  • RenderWindow.cpp
  • RenderWindow.hpp
  • Resource.hpp
  • Resource.inl
  • ResourcePtr.inl
  • Selector.hpp
  • Selector.inl
  • SelectorBase.cpp
  • SelectorBase.hpp
  • SFML_Main.cpp
  • Shape.cpp
  • Shape.hpp
  • Sleep.cpp
  • Sleep.hpp
  • SocketHelper.cpp
  • SocketHelper.hpp
  • Win32/SocketHelper.hpp
  • Sockets.hpp
  • SocketTCP.cpp
  • SocketTCP.hpp
  • SocketUDP.cpp
  • SocketUDP.hpp
  • Sound.cpp
  • Sound.hpp
  • SoundBuffer.cpp
  • SoundBuffer.hpp
  • SoundBufferRecorder.cpp
  • SoundBufferRecorder.hpp
  • SoundFile.cpp
  • SoundFile.hpp
  • SoundFileDefault.cpp
  • SoundFileDefault.hpp
  • SoundFileOgg.cpp
  • SoundFileOgg.hpp
  • SoundRecorder.cpp
  • SoundRecorder.hpp
  • SoundStream.cpp
  • SoundStream.hpp
  • Sprite.cpp
  • Sprite.hpp
  • String.cpp
  • String.hpp
  • System.hpp
  • Thread.cpp
  • Thread.hpp
  • Win32/Thread.hpp
  • Unicode.cpp
  • Unicode.hpp
  • Unicode.inl
  • Vector2.hpp
  • Vector2.inl
  • Vector3.hpp
  • Vector3.inl
  • VideoMode.cpp
  • VideoMode.hpp
  • Cocoa/VideoModeSupport.cpp
  • Template for new ports/VideoModeSupport.cpp
  • Win32/VideoModeSupport.cpp
  • Cocoa/VideoModeSupport.hpp
  • Template for new ports/VideoModeSupport.hpp
  • VideoModeSupport.hpp
  • Win32/VideoModeSupport.hpp
  • View.cpp
  • View.hpp
  • Window.cpp
  • Window/Window.hpp
  • Window.hpp
  • WindowHandle.hpp
  • WindowImpl.cpp
  • WindowImpl.hpp
  • WindowImplCocoa.hpp
  • WindowImplWin32.cpp
  • WindowImplWin32.hpp
  • WindowImplXXX.cpp
  • WindowImplXXX.hpp
  • WindowListener.hpp
  • WindowSettings.hpp
  • WindowStyle.hpp

Get in touch

Submit feedback about this site to:

• [email protected]

© documentation.help. Design: rehmann.co.