blob: 576b37dffeabbc0159c7e5d85a39c7d997cb1f49 [file] [log] [blame]
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
* The Original Code is the Netscape Portable Runtime (NSPR).
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998-2000
* the Initial Developer. All Rights Reserved.
* Contributor(s):
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
* ***** END LICENSE BLOCK ***** */
** Class definitions for normal and special file I/O (ref: prio.h)
#if defined(_RCFILEIO_H)
#define _RCFILEIO_H
#include "rcio.h"
#include "rctime.h"
** One would normally create a concrete class, such as RCFileIO, but then
** pass around more generic references, ie., RCIO.
** This subclass of RCIO hides (makes private) the methods that are not
** applicable to normal files.
class RCFileInfo;
class PR_IMPLEMENT(RCFileIO): public RCIO
virtual ~RCFileIO();
virtual PRInt64 Available();
virtual PRStatus Close();
static PRStatus Delete(const char *name);
virtual PRStatus FileInfo(RCFileInfo* info) const;
static PRStatus FileInfo(const char *name, RCFileInfo* info);
virtual PRStatus Fsync();
virtual PRStatus Open(const char *name, PRIntn flags, PRIntn mode);
virtual PRInt32 Read(void *buf, PRSize amount);
virtual PRInt64 Seek(PRInt64 offset, RCIO::Whence how);
virtual PRInt32 Write(const void *buf, PRSize amount);
virtual PRInt32 Writev(
const PRIOVec *iov, PRSize size,
const RCInterval& timeout);
/* These methods made private are unavailable for this object */
RCFileIO(const RCFileIO&);
void operator=(const RCFileIO&);
RCIO* Accept(RCNetAddr* addr, const RCInterval& timeout);
PRInt32 AcceptRead(
RCIO **newfd, RCNetAddr **address, void *buffer,
PRSize amount, const RCInterval& timeout);
PRStatus Bind(const RCNetAddr& addr);
PRStatus Connect(const RCNetAddr& addr, const RCInterval& timeout);
PRStatus GetLocalName(RCNetAddr *addr) const;
PRStatus GetPeerName(RCNetAddr *addr) const;
PRStatus GetSocketOption(PRSocketOptionData *data) const;
PRStatus Listen(PRIntn backlog);
PRInt16 Poll(PRInt16 in_flags, PRInt16 *out_flags);
PRInt32 Recv(
void *buf, PRSize amount, PRIntn flags,
const RCInterval& timeout);
PRInt32 Recvfrom(
void *buf, PRSize amount, PRIntn flags,
RCNetAddr* addr, const RCInterval& timeout);
PRInt32 Send(
const void *buf, PRSize amount, PRIntn flags,
const RCInterval& timeout);
PRInt32 Sendto(
const void *buf, PRSize amount, PRIntn flags,
const RCNetAddr& addr,
const RCInterval& timeout);
PRStatus SetSocketOption(const PRSocketOptionData *data);
PRStatus Shutdown(RCIO::ShutdownHow how);
PRInt32 TransmitFile(
RCIO *source, const void *headers,
PRSize hlen, RCIO::FileDisposition flags,
const RCInterval& timeout);
** The following function return a valid normal file object,
** Such objects can be used for scanned input and console output.
typedef enum {
input = PR_StandardInput,
output = PR_StandardOutput,
error = PR_StandardError
} SpecialFile;
static RCIO *GetSpecialFile(RCFileIO::SpecialFile special);
}; /* RCFileIO */
class PR_IMPLEMENT(RCFileInfo): public RCBase
typedef enum {
file = PR_FILE_FILE,
directory = PR_FILE_DIRECTORY,
} FileType;
RCFileInfo(const RCFileInfo&);
virtual ~RCFileInfo();
PRInt64 Size() const;
RCTime CreationTime() const;
RCTime ModifyTime() const;
RCFileInfo::FileType Type() const;
friend PRStatus RCFileIO::FileInfo(RCFileInfo*) const;
friend PRStatus RCFileIO::FileInfo(const char *name, RCFileInfo*);
PRFileInfo64 info;
}; /* RCFileInfo */
inline RCFileInfo::RCFileInfo(): RCBase() { }
inline PRInt64 RCFileInfo::Size() const { return info.size; }
#endif /* defined(_RCFILEIO_H) */