Ck::IO::File Class Reference

#include <ckio.h>

Collaboration diagram for Ck::IO::File:

[legend]

Public Member Functions
	File (int token_)
	File ()
void	pup (PUP::er &p)
Private Attributes
int	token
Friends
class	FileReadyMsg
void	startSession (File file, size_t bytes, size_t offset, CkCallback ready, CkCallback complete)
	Prepare to write data into the file described by token, in the window defined by the offset and byte length.
void	startSession (File file, size_t bytes, size_t offset, CkCallback ready, const char *commitData, size_t commitBytes, size_t commitOffset, CkCallback complete)
	Prepare to write data into.
void	close (File file, CkCallback closed)
	Close a previously-opened file.

---

Detailed Description

Definition at line 74 of file ckio.h.

---

Constructor & Destructor Documentation

Ck::IO::File::File

(

int

token_

)

[inline]

Definition at line 85 of file ckio.h.

Ck::IO::File::File

(

)

[inline]

Definition at line 86 of file ckio.h.

---

Member Function Documentation

void Ck::IO::File::pup

(

PUP::er &

p

)

[inline]

Definition at line 87 of file ckio.h.

References token.

---

Friends And Related Function Documentation

friend class FileReadyMsg [friend]

Definition at line 82 of file ckio.h.

void startSession	(	File	file,
		size_t	bytes,
		size_t	offset,
		CkCallback	ready,
		CkCallback	complete
	)			[friend]

Prepare to write data into the file described by token, in the window defined by the offset and byte length.

When the session is set up, a SessionReadyMsg will be sent to the ready callback. When all of the data has been written and synced, a message will be sent to the complete callback.

Definition at line 410 of file ckio.C.

void startSession	(	File	file,
		size_t	bytes,
		size_t	offset,
		CkCallback	ready,
		const char *	commitData,
		size_t	commitBytes,
		size_t	commitOffset,
		CkCallback	complete
	)			[friend]

Prepare to write data into.

• file, in the window defined by the
• offset and length in
• bytes. When the session is set up, a SessionReadyMsg will be sent to the
• ready callback. When all of the data has been written and synced, an additional write will be made to the file to `commit' the session's work. When that write has completed, a message will be sent to the
• complete callback.

Definition at line 414 of file ckio.C.

void close	(	File	file,
		CkCallback	closed
	)			[friend]

Close a previously-opened file.

All sessions on that file must have already signalled that they are complete.

Definition at line 427 of file ckio.C.

---

Field Documentation

int Ck::IO::File::token [private]

Definition at line 75 of file ckio.h.

Referenced by Ck::IO::close(), pup(), and Ck::IO::startSession().

---

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

• libs/ck-libs/io/ckio.h