java/src/main/com/google/appengine/api/socket/AppEngineDatagramSocketImpl.java

   1 // Copyright 2012 Google Inc. All Rights Reserved.
   2
   3 package com.google.appengine.api.socket;
   4
   5 import com.google.appengine.api.socket.AppEngineSocketOptions.Option;
   6 import com.google.appengine.api.socket.SocketServicePb.AddressPort;
   7 import com.google.appengine.api.socket.SocketServicePb.BindReply;
   8 import com.google.appengine.api.socket.SocketServicePb.BindRequest;
   9 import com.google.appengine.api.socket.SocketServicePb.CloseReply;
  10 import com.google.appengine.api.socket.SocketServicePb.CloseRequest;
  11 import com.google.appengine.api.socket.SocketServicePb.CreateSocketReply;
  12 import com.google.appengine.api.socket.SocketServicePb.CreateSocketRequest;
  13 import com.google.appengine.api.socket.SocketServicePb.CreateSocketRequest.SocketFamily;
  14 import com.google.appengine.api.socket.SocketServicePb.CreateSocketRequest.SocketProtocol;
  15 import com.google.appengine.api.socket.SocketServicePb.GetSocketNameReply;
  16 import com.google.appengine.api.socket.SocketServicePb.GetSocketNameRequest;
  17 import com.google.appengine.api.socket.SocketServicePb.GetSocketOptionsReply;
  18 import com.google.appengine.api.socket.SocketServicePb.GetSocketOptionsRequest;
  19 import com.google.appengine.api.socket.SocketServicePb.ReceiveReply;
  20 import com.google.appengine.api.socket.SocketServicePb.ReceiveRequest;
  21 import com.google.appengine.api.socket.SocketServicePb.SendReply;
  22 import com.google.appengine.api.socket.SocketServicePb.SendRequest;
  23 import com.google.appengine.api.socket.SocketServicePb.SetSocketOptionsReply;
  24 import com.google.appengine.api.socket.SocketServicePb.SetSocketOptionsRequest;
  25 import com.google.appengine.api.socket.SocketServicePb.SocketOption.SocketOptionName;
  26
  27 import java.io.IOException;
  28 import java.io.Serializable;
  29 import java.net.DatagramPacket;
  30 import java.net.DatagramSocketImpl;
  31 import java.net.InetAddress;
  32 import java.net.NetworkInterface;
  33 import java.net.SocketAddress;
  34 import java.net.SocketException;
  35 import java.net.SocketOptions;
  36 import java.util.Arrays;
  37
  38 /**
  39  * Implements the {@link DatagramSocketImpl} interface for App Engine based datagram sockets.
  40  *
  41  */
  42 class AppEngineDatagramSocketImpl
  43     extends DatagramSocketImpl implements AppEngineSocketOptionsClient, Serializable {
  44
  45   private SocketApiHelper socketHelper = null;
  46
  47   String descriptor;
  48   volatile int timeout = -1;
  49
  50   AppEngineDatagramSocketImpl() {
  51   }
  52
  53   AppEngineDatagramSocketImpl(SocketApiHelper socketHelper) {
  54     this.socketHelper = socketHelper;
  55   }
  56
  57   SocketApiHelper getSocketApiHelper() {
  58     return socketHelper == null ? AppEngineSocketImplFactory.SOCKET_API_HELPER : socketHelper;
  59   }
  60
  61   void setOption(
  62       AppEngineSocketOptions.Option option, Object value) throws SocketException {
  63     checkNotClosed();
  64     option.validateAndApply(this, value);
  65   }
  66
  67   @Override
  68   public void setTimeout(int timeout) {
  69     this.timeout = timeout;
  70   }
  71
  72   @Override
  73   public void setSocketOptionAsBytes(Option option, byte[] value) throws SocketException {
  74     SocketOptionName name = option.getOptName();
  75     if (name == null) {
  76       return;
  77     }
  78
  79     SetSocketOptionsRequest request = new SetSocketOptionsRequest();
  80     request.setSocketDescriptor(descriptor);
  81     request.addOptions().setLevel(option.getLevel()).setOption(name).setValueAsBytes(value);
  82
  83     getSocketApiHelper().makeSyncCall(
  84         "SetSocketOptions", request, new SetSocketOptionsReply(), null);
  85   }
  86
  87   @Override
  88   public void setOption(int optID, Object value) throws SocketException {
  89     AppEngineSocketOptions.Option option = AppEngineSocketOptions.getOptionById(optID);
  90     if (option == null) {
  91       throw new SocketException("unrecognized socket option: " + optID);
  92     }
  93     setOption(option, value);
  94   }
  95
  96   @Override
  97   public Object getOption(int optID) throws SocketException {
  98     if (SocketOptions.SO_TIMEOUT == optID) {
  99       checkNotClosed();
 100       return timeout < 0 ? Integer.MAX_VALUE : timeout;
 101     }
 102     AppEngineSocketOptions.Option option = AppEngineSocketOptions.getOptionById(optID);
 103     if (option == null) {
 104       throw new SocketException("unrecognized socket option: " + optID);
 105     }
 106     return getOption(option);
 107   }
 108
 109   /**
 110    * Returns the value of the given option.
 111    * @throws SocketException
 112    */
 113   private Object getOption(Option option) throws SocketException {
 114     return option.getOption(this);
 115   }
 116
 117   /**
 118    * @throws SocketException
 119    * @see AppEngineSocketOptionsClient#getSocketOptionAsBytes(Option)
 120    */
 121   @Override
 122   public byte[] getSocketOptionAsBytes(Option option) throws SocketException {
 123     checkNotClosed();
 124     switch (option) {
 125       case SO_BINDADDR_OPT: {
 126         GetSocketNameRequest request = new GetSocketNameRequest();
 127         GetSocketNameReply response = new GetSocketNameReply();
 128         request.setSocketDescriptor(descriptor);
 129         getSocketApiHelper().makeSyncCall("GetSocketName", request, response, null);
 130         return response.getProxyExternalIp().getPackedAddressAsBytes();
 131       }
 132       default: {
 133         GetSocketOptionsRequest request = new GetSocketOptionsRequest();
 134         GetSocketOptionsReply response = new GetSocketOptionsReply();
 135         request.setSocketDescriptor(descriptor);
 136         request.addOptions().setLevel(option.getLevel()).setOption(option.getOptName());
 137         getSocketApiHelper().makeSyncCall("GetSocketOptions", request, response, null);
 138         return response.optionss().get(0).getValueAsBytes();
 139       }
 140     }
 141   }
 142
 143   /**
 144    * @throws SocketException if the socket is not open.
 145    */
 146   private void checkNotClosed() throws SocketException {
 147     if (descriptor == null) {
 148       throw new SocketException("socket closed");
 149     }
 150   }
 151
 152   @Override
 153   protected void create() throws SocketException {
 154     if (descriptor != null) {
 155       throw new SocketException("create may not be called on an already created socket.");
 156     }
 157
 158     CreateSocketRequest request = new CreateSocketRequest();
 159     CreateSocketReply response = new CreateSocketReply();
 160
 161     request.setFamily(SocketFamily.IPv6);
 162     request.setProtocol(SocketProtocol.UDP);
 163
 164     getSocketApiHelper().makeSyncCall("CreateSocket", request, response, null);
 165     descriptor = response.getSocketDescriptor();
 166   }
 167
 168   @Override
 169   protected void bind(int lport, InetAddress laddr) throws SocketException {
 170     checkNotClosed();
 171     BindRequest request = new BindRequest().setSocketDescriptor(descriptor);
 172     request.setProxyExternalIp(AppEngineSocketUtils.toAddressPort(laddr, lport));
 173     getSocketApiHelper().makeSyncCall("Bind", request, new BindReply(), null);
 174   }
 175
 176   @Override
 177   protected void send(DatagramPacket p) throws IOException {
 178     checkNotClosed();
 179     byte[] bytes = p.getData();
 180     int off = p.getOffset();
 181     int len = p.getLength();
 182     if (bytes.length != len || off != 0) {
 183       bytes = Arrays.copyOfRange(bytes, off, off + len);
 184     }
 185     SendRequest request = new SendRequest().setSocketDescriptor(descriptor)
 186                                            .setDataAsBytes(bytes);
 187     InetAddress addr = p.getAddress();
 188     if (addr != null) {
 189       request.setSendTo(AppEngineSocketUtils.toAddressPort(addr, p.getPort()));
 190     }
 191     if (timeout != -1) {
 192       request.setTimeoutSeconds(timeout * 0.001);
 193     }
 194     getSocketApiHelper().makeSyncCall("Send", request, new SendReply(), null);
 195   }
 196
 197   @Override
 198   protected int peek(InetAddress i) throws IOException {
 199     throw new SocketException("#peek(InetAddress) is not implemented.");
 200   }
 201
 202   @Override
 203   protected int peekData(DatagramPacket p) throws IOException {
 204     checkNotClosed();
 205     receiveOrPeek(p, true);
 206     return p.getPort();
 207   }
 208
 209   @Override
 210   protected void receive(DatagramPacket p) throws IOException {
 211     checkNotClosed();
 212     receiveOrPeek(p, false);
 213   }
 214
 215   private void receiveOrPeek(DatagramPacket p, boolean isPeek) throws IOException {
 216     checkNotClosed();
 217
 218     ReceiveReply response = new ReceiveReply();
 219     ReceiveRequest request = new ReceiveRequest().setSocketDescriptor(descriptor)
 220                                                  .setDataSize(p.getLength());
 221     if (timeout != -1) {
 222       request.setTimeoutSeconds(timeout * 0.001);
 223     }
 224
 225     if (isPeek) {
 226       request.setFlags(ReceiveRequest.Flags.MSG_PEEK.getValue());
 227     }
 228
 229     getSocketApiHelper().makeSyncCall("Receive", request, response, null);
 230
 231     byte[] readBytes = response.getDataAsBytes();
 232
 233     if (readBytes.length > 0) {
 234       System.arraycopy(readBytes, 0, p.getData(), p.getOffset(), readBytes.length);
 235     }
 236     p.setLength(readBytes.length);
 237
 238     AddressPort addrPort = response.getReceivedFrom();
 239     p.setPort(addrPort.getPort());
 240     p.setAddress(InetAddress.getByAddress(addrPort.getPackedAddressAsBytes()));
 241   }
 242
 243   @Deprecated
 244   @Override
 245   protected void setTTL(byte ttl) throws IOException {
 246     setTimeToLive(ttl);
 247   }
 248
 249   @Deprecated
 250   @Override
 251   protected byte getTTL() throws IOException {
 252     return (byte) getTimeToLive();
 253   }
 254
 255   @Override
 256   protected void setTimeToLive(int ttl) throws IOException {
 257     throw new SecurityException("App Engine does not allow multicast setTimeToLive");
 258   }
 259
 260   @Override
 261   protected int getTimeToLive() throws IOException {
 262     throw new SecurityException("App Engine does not allow multicast getTimeToLive");
 263   }
 264
 265   @Override
 266   protected void join(InetAddress inetaddr) throws IOException {
 267     throw new SecurityException("App Engine does not allow multicast join");
 268   }
 269
 270   @Override
 271   protected void leave(InetAddress inetaddr) throws IOException {
 272     throw new SecurityException("App Engine does not allow multicast leave");
 273   }
 274
 275   @Override
 276   protected void joinGroup(SocketAddress mcastaddr, NetworkInterface netIf) throws IOException {
 277     throw new SecurityException("App Engine does not allow multicast joinGroup");
 278   }
 279
 280   @Override
 281   protected void leaveGroup(SocketAddress mcastaddr, NetworkInterface netIf) throws IOException {
 282     throw new SecurityException("App Engine does not allow multicast leaveGroup");
 283   }
 284
 285   @Override
 286   protected void close() {
 287     if (descriptor != null) {
 288       try {
 289         CloseRequest request = new CloseRequest().setSocketDescriptor(descriptor);
 290         getSocketApiHelper().makeSyncCall("Close", request, new CloseReply(), null);
 291       } catch (SocketException e) {
 292       } finally {
 293         descriptor = null;
 294       }
 295     }
 296   }
 297 }