Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1080)

Unified Diff: ppapi/c/dev/ppb_transport_dev.h

Issue 6478018: Basic implementation of Pepper Transport API. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: updated copyright year Created 9 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: ppapi/c/dev/ppb_transport_dev.h
diff --git a/ppapi/c/dev/ppb_transport_dev.h b/ppapi/c/dev/ppb_transport_dev.h
index 7dc9ad3343ac3f21bc5fe3675319c62622ce162e..72ebb67b764a00675779a1a098aec3676ba8fac4 100644
--- a/ppapi/c/dev/ppb_transport_dev.h
+++ b/ppapi/c/dev/ppb_transport_dev.h
@@ -1,4 +1,4 @@
-/* Copyright (c) 2010 The Chromium Authors. All rights reserved.
+/* Copyright (c) 2011 The Chromium Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
@@ -16,8 +16,8 @@
#define PPB_TRANSPORT_DEV_INTERFACE "PPB_Transport;0.4"
struct PPB_Transport_Dev {
- // Creates a new transport object with the specified name
- // using the specified protocol.
+ // Creates a new transport object with the specified name using the
+ // specified protocol.
PP_Resource (*CreateTransport)(PP_Instance instance,
const char* name,
const char* proto);
@@ -25,23 +25,24 @@ struct PPB_Transport_Dev {
// Returns PP_TRUE if resource is a Transport, PP_FALSE otherwise.
PP_Bool (*IsTransport)(PP_Resource resource);
- // Returns PP_TRUE if the transport is currently writable
- // (i.e. can send data to the remote peer), PP_FALSE otherwise.
+ // Returns PP_TRUE if the transport is currently writable (i.e. can
+ // send data to the remote peer), PP_FALSE otherwise.
PP_Bool (*IsWritable)(PP_Resource transport);
// TODO(juberti): other getters/setters
// connect state
// connect type, protocol
// RTT
- // Establishes a connection to the remote peer.
- // Returns PP_ERROR_WOULDBLOCK and notifies on |cb|
- // when connectivity is established (or timeout occurs).
+ // Establishes a connection to the remote peer. Returns
+ // PP_ERROR_WOULDBLOCK and notifies on |cb| when connectivity is
+ // established (or timeout occurs).
int32_t (*Connect)(PP_Resource transport,
struct PP_CompletionCallback cb);
- // Obtains another ICE candidate address to be provided
- // to the remote peer. Returns PP_ERROR_WOULDBLOCK
- // if there are no more addresses to be sent.
+ // Obtains another ICE candidate address to be provided to the
+ // remote peer. Returns PP_ERROR_WOULDBLOCK if there are no more
+ // addresses to be sent. After the callback is called
+ // GetNextAddress() must be called again to get the address.
int32_t (*GetNextAddress)(PP_Resource transport,
struct PP_Var* address,
struct PP_CompletionCallback cb);
@@ -50,14 +51,16 @@ struct PPB_Transport_Dev {
int32_t (*ReceiveRemoteAddress)(PP_Resource transport,
struct PP_Var address);
- // Like recv(), receives data. Returns PP_ERROR_WOULDBLOCK
- // if there is currently no data to receive.
+ // Like recv(), receives data. Returns PP_ERROR_WOULDBLOCK if there
+ // is currently no data to receive. In that case, the |data| pointer
+ // should remain valid until the callback is called.
int32_t (*Recv)(PP_Resource transport,
void* data,
uint32_t len,
struct PP_CompletionCallback cb);
- // Like send(), sends data. Returns PP_ERROR_WOULDBLOCK
- // if the socket is currently flow-controlled.
+ // Like send(), sends data. Returns PP_ERROR_WOULDBLOCK if the
+ // socket is currently flow-controlled. In that case, the |data|
+ // pointer should remain valid until the callback is called.
int32_t (*Send)(PP_Resource transport,
const void* data,
uint32_t len,
@@ -68,4 +71,3 @@ struct PPB_Transport_Dev {
};
#endif /* PPAPI_C_PPB_TRANSPORT_DEV_H_ */
-

Powered by Google App Engine
This is Rietveld 408576698