1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
/*
* Copyright (c) 2008 - 2009
* Jonathan Schleifer <js@webkeks.org>
*
* All rights reserved.
*
* This file is part of libobjfw. It may be distributed under the terms of the
* Q Public License 1.0, which can be found in the file LICENSE included in
* the packaging of this file.
*/
/**
* The OFStream protocol provides functions to read from and write to streams.
*/
@protocol OFStream
/**
* Reads from the stream into a buffer.
*
* \param buf The buffer into which the data is read
* \param size The size of the data that should be read.
* The buffer MUST be at least size big!
* \return The number of bytes read
*/
- (size_t)readNBytes: (size_t)size
intoBuffer: (char*)buf;
/**
* Writes from a buffer into the stream.
*
* \param buf The buffer from which the data is written to the stream
* \param size The size of the data that should be written
* \return The number of bytes written
*/
- (size_t)writeNBytes: (size_t)size
fromBuffer: (const char*)buf;
/**
* Writes a C string into the stream, without the trailing zero.
*
* \param str The C string from which the data is written to the stream
* \return The number of bytes written
*/
- (size_t)writeCString: (const char*)str;
/**
* Closes the stream.
*/
- close;
@end
|
>
>
|
|
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
/*
* Copyright (c) 2008 - 2009
* Jonathan Schleifer <js@webkeks.org>
*
* All rights reserved.
*
* This file is part of libobjfw. It may be distributed under the terms of the
* Q Public License 1.0, which can be found in the file LICENSE included in
* the packaging of this file.
*/
#import "OFObject.h"
/**
* The OFStream class provides a base class for different types of streams.
*/
@interface OFStream: OFObject
{
char *cache;
size_t cache_len;
}
/**
* Reads from the stream into a buffer.
*
* \param buf The buffer into which the data is read
* \param size The size of the data that should be read.
* The buffer MUST be at least size big!
* \return The number of bytes read
*/
- (size_t)readNBytes: (size_t)size
intoBuffer: (char*)buf;
/**
* Read until a newline or \0 occurs.
*
* If you want to use readNBytes afterwards again, you have to clear the cache
* before and optionally get the cache before clearing it!
*
* \return The line that was read. Use freeMem: to free it!
*/
- (char*)readLine;
/**
* Writes from a buffer into the stream.
*
* \param buf The buffer from which the data is written to the stream
* \param size The size of the data that should be written
* \return The number of bytes written
*/
- (size_t)writeNBytes: (size_t)size
fromBuffer: (const char*)buf;
/**
* Writes a C string into the stream, without the trailing zero.
*
* \param str The C string from which the data is written to the stream
* \return The number of bytes written
*/
- (size_t)writeCString: (const char*)str;
/**
* Sets a specified pointer to the cache and returns the length of the cache.
*
* \param ptr A pointer to a pointer. It will be set to the cache.
* If it is NULL, only the number of bytes in the cache is returned.
* \return The number of bytes in the cache.
*/
- (size_t)getCache: (char**)ptr;
/**
* Clears the cache.
*/
- clearCache;
/**
* Closes the stream.
*/
- close;
@end
|