wxJavaScript

back to io 

wxProtocol

^{generated from ../src/mod_io/protocol.cpp}

Prototype for all protocol classes.

Constants

wxProtocolError

Name	Description
NOERR	No error
NETERR	A generic network error occurred.
PROTERR	An error occurred during negotiation.
CONNERR	The client failed to connect the server.
INVVAL	Invalid value.
NOHNDLR
NOFILE	The remote file doesn't exist.
ABRT	Last action aborted.
RCNCT	An error occurred during reconnection.
STREAMING	Someone tried to send a command during a transfer.

wxProtocolError is ported to JavaScript as a separate class. Note that this class doesn't exist in wxWidgets.

Properties

Name	Type	Description
contentType	String	Returns the type of the content of the last opened stream. It is a mime-type
error	Integer	Returns the last occurred error. See wxProtocolError.

Methods

abort

abort() : Boolean
 

Abort the current stream.

getInputStream

getInputStream(Path) : wxInputStream
 

Name	Type	Default	Description
Path	String

Creates a new input stream on the specified path. You can use all but seek functionality of wxStream. seekI isn't available on all stream. For example, http or ftp streams doesn't deal with it. Other functions like size aren't available for the moment for this sort of stream. You will be notified when the EOF is reached by an error.

reconnect

reconnect() : Boolean
 

Tries to reestablish a previous opened connection (close and renegotiate connection).

setPassword

setPassword(pwd)
 

Name	Type	Default	Description
pwd	String

Sets the authentication password. It is mainly useful when FTP is used.

setUser

setUser(user)
 

Name	Type	Default	Description
user	String

Sets the authentication user. It is mainly useful when FTP is used.