#include <spdylay/spdylay.h>

Include dependency graph for SpdyCallbacks.h:

This graph shows which files directly or indirectly include this file:

Functions
void	spdy_callbacks_init (spdylay_session_callbacks *callbacks)
void	spdy_prepare_status_response_and_clean_request (SpdyClientSession sm, int stream_id, const char status)
ssize_t	spdy_send_callback (spdylay_session session, const uint8_t data, size_t length, int flags, void *user_data)

ssize_t	spdy_recv_callback (spdylay_session session, uint8_t buf, size_t length, int flags, void *user_data)

void	spdy_on_ctrl_recv_callback (spdylay_session session, spdylay_frame_type type, spdylay_frame frame, void *user_data)

void	spdy_on_invalid_ctrl_recv_callback (spdylay_session session, spdylay_frame_type type, spdylay_frame frame, uint32_t status_code, void *user_data)

void	spdy_on_data_chunk_recv_callback (spdylay_session session, uint8_t flags, int32_t stream_id, const uint8_t data, size_t len, void *user_data)

void	spdy_on_data_recv_callback (spdylay_session session, uint8_t flags, int32_t stream_id, int32_t length, void user_data)

void	spdy_before_ctrl_send_callback (spdylay_session session, spdylay_frame_type type, spdylay_frame frame, void *user_data)

void	spdy_on_ctrl_send_callback (spdylay_session session, spdylay_frame_type type, spdylay_frame frame, void *user_data)

void	spdy_on_ctrl_not_send_callback (spdylay_session session, spdylay_frame_type type, spdylay_frame frame, int error_code, void *user_data)

void	spdy_on_data_send_callback (spdylay_session session, uint8_t flags, int32_t stream_id, int32_t length, void user_data)

void	spdy_on_stream_close_callback (spdylay_session session, int32_t stream_id, spdylay_status_code status_code, void user_data)

ssize_t	spdy_get_credential_proof (spdylay_session session, const spdylay_origin origin, uint8_t proof, size_t prooflen, void user_data)

ssize_t	spdy_get_credential_ncerts (spdylay_session session, const spdylay_origin origin, void *user_data)

ssize_t	spdy_get_credential_cert (spdylay_session session, const spdylay_origin origin, size_t idx, uint8_t cert, size_t certlen, void user_data)

void	spdy_on_request_recv_callback (spdylay_session session, int32_t stream_id, void user_data)

void	spdy_on_ctrl_recv_parse_error_callback (spdylay_session session, spdylay_frame_type type, const uint8_t head, size_t headlen, const uint8_t payload, size_t payloadlen, int error_code, void user_data)

void	spdy_on_unknown_ctrl_recv_callback (spdylay_session session, const uint8_t head, size_t headlen, const uint8_t payload, size_t payloadlen, void user_data)

Detailed Description

SpdyCallbacks.h.

License

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.

Definition in file SpdyCallbacks.h.

Function Documentation

void spdy_before_ctrl_send_callback	(	spdylay_session *	session,
		spdylay_frame_type	type,
		spdylay_frame *	frame,
		void *	user_data
	)

Callback function invoked before the control frame |frame| of type |type| is sent. This may be useful, for example, to know the stream ID of SYN_STREAM frame (see also `spdylay_session_get_stream_user_data()`), which is not assigned when it was queued.

Definition at line 418 of file SpdyCallbacks.cc.

void spdy_callbacks_init ( spdylay_session_callbacks * callbacks )

Definition at line 29 of file SpdyCallbacks.cc.

Referenced by spdy_config_load().

ssize_t spdy_get_credential_cert	(	spdylay_session *	session,
		const spdylay_origin *	origin,
		size_t	idx,
		uint8_t *	cert,
		size_t	certlen,
		void *	user_data
	)

Definition at line 490 of file SpdyCallbacks.cc.

ssize_t spdy_get_credential_ncerts	(	spdylay_session *	session,
		const spdylay_origin *	origin,
		void *	user_data
	)

Callback function invoked when the library needs the length of the client certificate chain for the given |origin|. The implementation of this function must return the length of the client certificate chain. If no client certificate is required for the given |origin|, return 0. If positive integer is returned, :type:`spdylay_get_credential_proof` and :type:`spdylay_get_credential_cert` callback functions will be used to get the cryptographic proof and certificate respectively.

Definition at line 481 of file SpdyCallbacks.cc.

ssize_t spdy_get_credential_proof	(	spdylay_session *	session,
		const spdylay_origin *	origin,
		uint8_t *	proof,
		size_t	prooflen,
		void *	user_data
	)

Because the client certificate vector has limited number of slots, the application code may be required to pass the same proof more than once.

Definition at line 470 of file SpdyCallbacks.cc.

void spdy_on_ctrl_not_send_callback	(	spdylay_session *	session,
		spdylay_frame_type	type,
		spdylay_frame *	frame,
		int	error_code,
		void *	user_data
	)

Definition at line 437 of file SpdyCallbacks.cc.

void spdy_on_ctrl_recv_callback	(	spdylay_session *	session,
		spdylay_frame_type	type,
		spdylay_frame *	frame,
		void *	user_data
	)

Callback function invoked by `spdylay_session_recv()` when a control frame is received.

Definition at line 309 of file SpdyCallbacks.cc.

References SpdyRequest::append_nv(), SpdyRequest::init(), SpdyClientSession::req_map, spdy_process_syn_stream_frame(), spdy_show_ctl_frame(), spdyRequestAllocator, TSVIOReenable(), and SpdyClientSession::write_vio.

void spdy_on_ctrl_recv_parse_error_callback	(	spdylay_session *	session,
		spdylay_frame_type	type,
		const uint8_t *	head,
		size_t	headlen,
		const uint8_t *	payload,
		size_t	payloadlen,
		int	error_code,
		void *	user_data
	)

Definition at line 511 of file SpdyCallbacks.cc.

void spdy_on_ctrl_send_callback	(	spdylay_session *	session,
		spdylay_frame_type	type,
		spdylay_frame *	frame,
		void *	user_data
	)

Callback function invoked after the control frame |frame| of type |type| is sent.

Definition at line 428 of file SpdyCallbacks.cc.

References spdy_show_ctl_frame().

void spdy_on_data_chunk_recv_callback	(	spdylay_session *	session,
		uint8_t	flags,
		int32_t	stream_id,
		const uint8_t *	data,
		size_t	len,
		void *	user_data
	)

Callback function invoked when a chunk of data in DATA frame is received. The |stream_id| is the stream ID this DATA frame belongs to. The |flags| is the flags of DATA frame which this data chunk is contained. ``(flags & SPDYLAY_DATA_FLAG_FIN) != 0`` does not necessarily mean this chunk of data is the last one in the stream. You should use :type:`spdylay_on_data_recv_callback` to know all data frames are received.

Definition at line 357 of file SpdyCallbacks.cc.

References Debug, SpdyRequest::fetch_sm, SpdyClientSession::find_request(), and TSFetchWriteData().

void spdy_on_data_recv_callback	(	spdylay_session *	session,
		uint8_t	flags,
		int32_t	stream_id,
		int32_t	length,
		void *	user_data
	)

Callback function invoked when DATA frame is received. The actual data it contains are received by :type:`spdylay_on_data_chunk_recv_callback`.

Definition at line 377 of file SpdyCallbacks.cc.

References Debug, SpdyRequest::delta_window_size, SpdyClientSession::find_request(), SpdyClientSession::sm_id, spdy_initial_window_size, spdy_show_data_frame(), TSVIOReenable(), and SpdyClientSession::write_vio.

void spdy_on_data_send_callback	(	spdylay_session *	session,
		uint8_t	flags,
		int32_t	stream_id,
		int32_t	length,
		void *	user_data
	)

Callback function invoked after DATA frame is sent.

Definition at line 448 of file SpdyCallbacks.cc.

References SpdyClientSession::read_vio, spdy_show_data_frame(), and TSVIOReenable().

void spdy_on_invalid_ctrl_recv_callback	(	spdylay_session *	session,
		spdylay_frame_type	type,
		spdylay_frame *	frame,
		uint32_t	status_code,
		void *	user_data
	)

Callback function invoked by `spdylay_session_recv()` when an invalid control frame is received. The |status_code| is one of the :enum:`spdylay_status_code` and indicates the error. When this callback function is invoked, the library automatically submits either RST_STREAM or GOAWAY frame.

Definition at line 346 of file SpdyCallbacks.cc.

void spdy_on_request_recv_callback	(	spdylay_session *	session,
		int32_t	stream_id,
		void *	user_data
	)

Callback function invoked when the request from the remote peer is received. In other words, the frame with FIN flag set is received. In HTTP, this means HTTP request, including request body, is fully received.

Definition at line 502 of file SpdyCallbacks.cc.

void spdy_on_stream_close_callback	(	spdylay_session *	session,
		int32_t	stream_id,
		spdylay_status_code	status_code,
		void *	user_data
	)

Callback function invoked when the stream |stream_id| is closed. The reason of closure is indicated by the |status_code|. The stream_user_data, which was specified in `spdylay_submit_request()` or `spdylay_submit_syn_stream()`, is still available in this function.

Definition at line 460 of file SpdyCallbacks.cc.

void spdy_on_unknown_ctrl_recv_callback	(	spdylay_session *	session,
		const uint8_t *	head,
		size_t	headlen,
		const uint8_t *	payload,
		size_t	payloadlen,
		void *	user_data
	)

Definition at line 525 of file SpdyCallbacks.cc.

void spdy_prepare_status_response_and_clean_request	(	SpdyClientSession *	sm,
		int	stream_id,
		const char *	status
	)

Definition at line 53 of file SpdyCallbacks.cc.

References SpdyClientSession::cleanup_request(), SpdyRequest::headers, http_date(), SpdyClientSession::req_map, SpdyClientSession::session, TSAssert, TSVIOReenable(), and SpdyClientSession::write_vio.

Referenced by spdy_process_fetch(), and spdy_process_syn_stream_frame().

ssize_t spdy_recv_callback	(	spdylay_session *	session,
		uint8_t *	buf,
		size_t	length,
		int	flags,
		void *	user_data
	)

Callback function invoked when |session| wants to receive data from the remote peer. The implementation of this function must read at most |length| bytes of data and store it in |buf|. The |flags| is currently not used and always 0. It must return the number of bytes written in |buf| if it succeeds. If it cannot read any single byte without blocking, it must return :enum:`SPDYLAY_ERR_WOULDBLOCK`. If it gets EOF before it reads any single byte, it must return :enum:`SPDYLAY_ERR_EOF`. For other errors, it must return :enum:`SPDYLAY_ERR_CALLBACK_FAILURE`.

Definition at line 227 of file SpdyCallbacks.cc.

References memcpy, SpdyClientSession::read_vio, SpdyClientSession::req_reader, start, TSIOBufferBlockNext(), TSIOBufferBlockReadStart(), TSIOBufferReaderConsume(), TSIOBufferReaderStart(), and TSVIOReenable().

ssize_t spdy_send_callback	(	spdylay_session *	session,
		const uint8_t *	data,
		size_t	length,
		int	flags,
		void *	user_data
	)

Callback function invoked when |session| wants to send data to the remote peer. The implementation of this function must send at most |length| bytes of data stored in |data|. The |flags| is currently not used and always 0. It must return the number of bytes sent if it succeeds. If it cannot send any single byte without blocking, it must return :enum:`SPDYLAY_ERR_WOULDBLOCK`. For other errors, it must return :enum:`SPDYLAY_ERR_CALLBACK_FAILURE`.

Definition at line 213 of file SpdyCallbacks.cc.

References Debug, SpdyClientSession::resp_buffer, SpdyClientSession::total_size, and TSIOBufferWrite().

SpdyCallbacks.h File Reference

Functions

Detailed Description

License

Function Documentation