summaryrefslogtreecommitdiff
path: root/lib/cocoa/src/transport/TTransport.h
blob: 61ebbd214f58b3750024f035821f92046cb26d1a (plain)
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
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

@protocol TTransport <NSObject>

  /**
   * Guarantees that all of len bytes are read
   *
   * @param buf Buffer to read into
   * @param off Index in buffer to start storing bytes at
   * @param len Maximum number of bytes to read
   * @return The number of bytes actually read, which must be equal to len
   * @throws TTransportException if there was an error reading data
   */
- (int) readAll: (uint8_t *) buf offset: (int) off length: (int) len;

- (void) write: (const uint8_t *) data offset: (unsigned int) offset length: (unsigned int) length;

- (void) flush;
@end