Repository: trafficserver Updated Branches: refs/heads/master 9c4dbffb5 -> cd60e20bd
[TS-3414]: Update docs for TSHttpTxnOutgoingAddrGet and TSHttpTxnIncomingAddrGet Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/cd60e20b Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/cd60e20b Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/cd60e20b Branch: refs/heads/master Commit: cd60e20bd4b554930a4d6eef77762154f5b1aed8 Parents: 9c4dbff Author: Sudheer Vinukonda <[email protected]> Authored: Tue Mar 3 17:00:51 2015 +0000 Committer: Sudheer Vinukonda <[email protected]> Committed: Tue Mar 3 17:00:51 2015 +0000 ---------------------------------------------------------------------- .../api/TSHttpTxnIncomingAddrGet.en.rst | 39 ++++++++++++++++++++ .../api/TSHttpTxnOutgoingAddrGet.en.rst | 39 ++++++++++++++++++++ 2 files changed, 78 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/cd60e20b/doc/reference/api/TSHttpTxnIncomingAddrGet.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/api/TSHttpTxnIncomingAddrGet.en.rst b/doc/reference/api/TSHttpTxnIncomingAddrGet.en.rst new file mode 100644 index 0000000..cd691c1 --- /dev/null +++ b/doc/reference/api/TSHttpTxnIncomingAddrGet.en.rst @@ -0,0 +1,39 @@ +.. 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. + + +TSHttpTxnIncomingAddrGet +======================== + +Get the incoming proxy address on which a client's connection is accepted. + + +Synopsis +-------- + +`#include <ts/ts.h>` + +.. c:function:: sockaddr const* TSHttpTxnIncomingAddrGet(TSHttpTxn txnp) + + +Description +----------- + +.. note:: + + The pointer is valid only for the current callback. Clients that + need to keep the value across callbacks must maintain their own + storage. http://git-wip-us.apache.org/repos/asf/trafficserver/blob/cd60e20b/doc/reference/api/TSHttpTxnOutgoingAddrGet.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/api/TSHttpTxnOutgoingAddrGet.en.rst b/doc/reference/api/TSHttpTxnOutgoingAddrGet.en.rst new file mode 100644 index 0000000..1a604af --- /dev/null +++ b/doc/reference/api/TSHttpTxnOutgoingAddrGet.en.rst @@ -0,0 +1,39 @@ +.. 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. + + +TSHttpTxnOutgoingAddrGet +======================== + +Get the outgoing address used in origin connection. + + +Synopsis +-------- + +`#include <ts/ts.h>` + +.. c:function:: sockaddr const* TSHttpTxnOutgoingAddrGet(TSHttpTxn txnp) + + +Description +----------- + +.. note:: + + The pointer is valid only for the current callback. Clients that + need to keep the value across callbacks must maintain their own + storage.
