View Javadoc
1   /*
2    * junixsocket
3    *
4    * Copyright 2009-2024 Christian Kohlschütter
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.newsclub.net.unix.tipc;
19  
20  import org.newsclub.net.unix.AFSocketExtensions;
21  
22  /**
23   * Defines certain methods that all junixsocket AF_TIPC socket implementations share and extend
24   * beyond the standard socket API.
25   *
26   * @author Christian Kohlschütter
27   */
28  public interface AFTIPCSocketExtensions extends AFSocketExtensions {
29    /**
30     * Returns the TIPC "ErrInfo" information from the ancillary receive buffer (if any was set), or
31     * {@code null} if no error was retrieved.
32     *
33     * @return The ErrInfo.
34     */
35    AFTIPCErrInfo getErrInfo();
36  
37    /**
38     * Returns the TIPC "DestName" information from the ancillary receive buffer (if any was set), or
39     * {@code null} if no DestName was retrieved.
40     *
41     * @return The service address or range (without scope) that was specified by the sender of the
42     *         message.
43     */
44    AFTIPCDestName getDestName();
45  }